www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/fontyourface/src/FontInterface.php

   1 <?php
   2
   3 namespace Drupal\fontyourface;
   4
   5 use Drupal\Core\Entity\ContentEntityInterface;
   6 use Drupal\Core\Entity\EntityChangedInterface;
   7
   8 /**
   9  * Provides an interface for defining Font entities.
  10  *
  11  * @ingroup fontyourface
  12  */
  13 interface FontInterface extends ContentEntityInterface, EntityChangedInterface {
  14
  15   /**
  16    * Gets the Font provider ID.
  17    *
  18    * @return string
  19    *   Font provider ID.
  20    */
  21   public function getProvider();
  22
  23   /**
  24    * Sets the Font provider ID.
  25    *
  26    * @param string $provider
  27    *   The Font provider ID.
  28    *
  29    * @return \Drupal\fontyourface\FontInterface
  30    *   The called Font entity.
  31    */
  32   public function setProvider($provider);
  33
  34   /**
  35    * Gets the Font metadata.
  36    *
  37    * @return mixed
  38    *   Mixed type of metadata.
  39    */
  40   public function getMetadata();
  41
  42   /**
  43    * Sets the Font metadata.
  44    *
  45    * @param mixed $metadata
  46    *   The Font metadata.
  47    *
  48    * @return \Drupal\fontyourface\FontInterface
  49    *   The called Font entity.
  50    */
  51   public function setMetadata($metadata);
  52
  53   /**
  54    * Gets the Font creation timestamp.
  55    *
  56    * @return int
  57    *   Creation timestamp of the Font.
  58    */
  59   public function getCreatedTime();
  60
  61   /**
  62    * Sets the Font creation timestamp.
  63    *
  64    * @param int $timestamp
  65    *   The Font creation timestamp.
  66    *
  67    * @return \Drupal\fontyourface\FontInterface
  68    *   The called Font entity.
  69    */
  70   public function setCreatedTime($timestamp);
  71
  72   /**
  73    * Gets the Font changed timestamp.
  74    *
  75    * @return int
  76    *   Creation timestamp of the Font.
  77    */
  78   public function getChangedTime();
  79
  80   /**
  81    * Sets the Font changed timestamp.
  82    *
  83    * @param int $timestamp
  84    *   The Font creation timestamp.
  85    *
  86    * @return \Drupal\fontyourface\FontInterface
  87    *   The called Font entity.
  88    */
  89   public function setChangedTime($timestamp);
  90
  91   /**
  92    * Checks if the font is enabled.
  93    *
  94    * @return bool
  95    *   TRUE is font is enabled. FALSE otherwise.
  96    */
  97   public function isEnabled();
  98
  99   /**
 100    * Checks if the font is disabled.
 101    *
 102    * @return bool
 103    *   TRUE is font is disabled. FALSE otherwise.
 104    */
 105   public function isDisabled();
 106
 107   /**
 108    * Enable a font.
 109    *
 110    * @return bool
 111    *   TRUE is font is enabled. FALSE otherwise.
 112    */
 113   public function enable();
 114
 115   /**
 116    * Disable a font.
 117    *
 118    * @return bool
 119    *   TRUE is font is disabled. FALSE otherwise.
 120    */
 121   public function disable();
 122
 123   /**
 124    * Returns list of enabled fonts.
 125    *
 126    * @return array
 127    *   Array of fonts.
 128    */
 129   public static function loadEnabledFonts();
 130
 131   /**
 132    * Returns font by url.
 133    *
 134    * @param string $font_url
 135    *   $The unique font url.
 136    *
 137    * @return array
 138    *   Array of fonts.
 139    */
 140   public static function loadByUrl($font_url);
 141
 142 }