class Skin in Skinr 8.2

Defines the Skin entity.

Plugin annotation


@ConfigEntityType(
  id = "skin",
  label = @Translation("Skin"),
  controllers = {
    "access" = "Drupal\skinr\SkinAccessController",
  },
  config_prefix = "skin",
  admin_permission = "administer skinr",
  fieldable = FALSE,
  entity_keys = {
    "id" = "uuid",
    "element_type" = "element_type",
    "element" = "element",
    "theme" = "theme",
    "skin" = "skin",
    "status" = "status",
  },
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\skinr\Entity\Skin implements SkinInterface

Expanded class hierarchy of Skin

4 files declare their use of Skin

SkinEditForm.php in skinr_ui/src/Form/SkinEditForm.php: Contains Drupal\skinr_ui\Form\SkinEditForm.
skinr.module in ./skinr.module: Handles core Skinr functionality.
SkinrApiTest.php in src/Tests/SkinrApiTest.php: Contains \Drupal\skinr\Tests\SkinrApiTest.
SkinsEditForm.php in skinr_ui/src/Form/SkinsEditForm.php: Contains Drupal\skinr_ui\Form\SkinsEditForm.

4 string references to 'Skin'

SkinEditForm::form in skinr_ui/src/Form/SkinEditForm.php: Gets the actual form array to be built.
SkinListBuilder::buildHeader in skinr_ui/src/Controller/SkinListBuilder.php: Builds the header row for the entity listing.
skinr.schema.yml in config/schema/skinr.schema.yml: config/schema/skinr.schema.yml
skinr_context_ui_admin_skin_list in skinr_context/skinr_context_ui.admin.inc: Overrides skinr_ui_list().

File

src/Entity/Skin.php, line 35: Contains \Drupal\skinr\Entity\Skin.

Namespace

Drupal\skinr\Entity

View source

class Skin extends ConfigEntityBase implements SkinInterface {

  /**
   * The element type this skin is applied to.
   *
   * @var string
   */
  public $element_type;

  /**
   * The element this skin is applied to.
   *
   * @var string
   */
  public $element;

  /**
   * The theme this skin is applies to.
   *
   * @var string
   */
  public $theme;

  /**
   * The theme this skin is applies to.
   *
   * @var string
   */
  public $skin;

  /**
   * The skin options.
   *
   * @var array
   */
  protected $options = array();

  /**
   * Overrides \Drupal\Core\Entity\Entity::id();
   */
  public function id() {
    return $this->uuid;
  }

  /**
   * Overrides \Drupal\Core\Entity\Entity::label();
   */
  public function label() {
    return $this->uuid;
  }

  /**
   * Returns the element_type label.
   */
  public function elementTypeLabel() {
    $config = skinr_get_config_info();
    return isset($config[$this->element_type]) ? $config[$this->element_type] : '';
  }

  /**
   * Returns the element label.
   *
   * @see hook_skinr_ui_element_title()
   */
  public function elementLabel() {
    $cache =& drupal_static(__FUNCTION__);
    $key = $this->element_type . '__' . $this->element . '__' . $this->theme;
    if (!isset($cache[$key])) {
      $titles = skinr_invoke_all('skinr_ui_element_title', $this->element_type, $this->element, $this->theme);
      $title = $titles ? reset($titles) : $this->element;
      $cache[$key] = $title;
    }
    return $cache[$key];
  }

  /**
   * Returns the theme label.
   */
  public function themeLabel() {
    $cache =& drupal_static(__FUNCTION__);
    if (!isset($cache[$this->theme])) {
      $theme = \Drupal::service('theme_handler')
        ->getTheme($this->theme);
      $cache[$this->theme] = $theme->info['name'];
    }
    return $cache[$this->theme];
  }

  /**
   * Returns the theme label.
   */
  public function skinLabel() {
    $cache =& drupal_static(__FUNCTION__);
    if (!isset($cache[$this->skin])) {
      $skin_infos = skinr_get_skin_info();

      // Add custom info.
      $skin_infos['_additional'] = array(
        'title' => t('Additional'),
      );
      $cache[$this->skin] = $skin_infos[$this->skin]['title'];
    }
    return $cache[$this->skin];
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return $this->options;
  }

  /**
   * {@inheritdoc}
   */
  public function getOption($option) {
    if (!isset($this->options[$option])) {
      return NULL;
    }
    return $this->options[$option];
  }

  /**
   * {@inheritdoc}
   */
  public function setOptions($options) {
    $this->options = $options;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setOption($option, $value) {
    $this->options[$option] = $value;
  }

  /**
   * {@inheritdoc}
   */
  public function getStorage() {

    // @todo Do we still need this?
    $default_skins = _skinr_skin_get_defaults();
    $storage = SKINR_STORAGE_IN_DATABASE;
    if (isset($default_skins[$this->uuid])) {
      $default_skin = clone $default_skins[$this->uuid];

      // Make sure skin has same processing as import.
      _skinr_skin_import($default_skin);

      // API version is only used for export.
      unset($default_skin->api_version);

      // Status shouldn't influence overridden.
      $default_skin->status = $this->status;
      $storage = SKINR_STORAGE_IN_CODE;
      if ($default_skin != $this) {

        // Default was overridden.
        $storage = SKINR_STORAGE_IN_CODE_OVERRIDDEN;
      }
    }
    return $storage;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	4
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
Skin::$element	public	property	The element this skin is applied to.
Skin::$element_type	public	property	The element type this skin is applied to.
Skin::$options	protected	property	The skin options.
Skin::$skin	public	property	The theme this skin is applies to.
Skin::$theme	public	property	The theme this skin is applies to.
Skin::elementLabel	public	function	Returns the element label.
Skin::elementTypeLabel	public	function	Returns the element_type label.
Skin::getOption	public	function	Returns a skin option value. Overrides SkinInterface::getOption
Skin::getOptions	public	function	Returns the skin options. Overrides SkinInterface::getOptions
Skin::getStorage	public	function
Skin::id	public	function	Overrides \Drupal\Core\Entity\Entity::id(); Overrides EntityBase::id
Skin::label	public	function	Overrides \Drupal\Core\Entity\Entity::label(); Overrides EntityBase::label
Skin::setOption	public	function	Sets a skin option value. Overrides SkinInterface::setOption
Skin::setOptions	public	function	Sets the skin options. Overrides SkinInterface::setOptions
Skin::skinLabel	public	function	Returns the theme label.
Skin::themeLabel	public	function	Returns the theme label.
SkinInterface::SKINR_STORAGE_IN_CODE		constant	Indicates the skin is stored in code.
SkinInterface::SKINR_STORAGE_IN_CODE_OVERRIDDEN		constant	Indicates the skin is overridden.
SkinInterface::SKINR_STORAGE_IN_DATABASE		constant	Indicates the skin is stored in database.
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class Skin in Skinr 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation