class SliderPro in Slider Pro 8

Same name in this branch

8 src/Entity/SliderPro.php \Drupal\slider_pro\Entity\SliderPro
8 src/Plugin/views/style/SliderPro.php \Drupal\slider_pro\Plugin\views\style\SliderPro

Defines the SliderPro entity.

Plugin annotation


@ConfigEntityType(
  id = "slider_pro",
  label = @Translation("Slider pro optionset"),
  handlers = {
    "list_builder" = "Drupal\slider_pro\Controller\SliderProListBuilder",
    "form" = {
      "add" = "Drupal\slider_pro\Form\SliderProForm",
      "edit" = "Drupal\slider_pro\Form\SliderProForm",
      "delete" = "Drupal\slider_pro\Form\SliderProDeleteForm"
    }
  },
  config_prefix = "optionset",
  admin_permission = "administer slider pro",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "status" = "status"
  },
  links = {
    "canonical" = "/admin/config/media/slider-pro/{slider_pro}",
    "edit-form" = "/admin/config/media/slider-pro/{slider_pro}/edit",
    "delete-form" = "/admin/config/media/slider-pro/{slider_pro}/delete",
    "collection" = "/admin/config/media/slider-pro"
  },
  config_export = {
    "id",
    "label",
    "options",
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\slider_pro\Entity\SliderPro implements SliderProInterface

Expanded class hierarchy of SliderPro

3 files declare their use of SliderPro

SliderProFormatter.php in src/Plugin/Field/FieldFormatter/SliderProFormatter.php
SliderProManager.php in src/Manager/SliderProManager.php
slider_pro_views.theme.inc in templates/slider_pro_views.theme.inc

File

src/Entity/SliderPro.php, line 42

Namespace

Drupal\slider_pro\Entity

View source

class SliderPro extends ConfigEntityBase implements SliderProInterface {

  /**
   * The Fslider pro optionset ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The slider pro optionset label.
   *
   * @var string
   */
  protected $label;

  /**
   * The slider pro optionset options.
   *
   * @var array
   */
  protected $options = [];

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

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

  /**
   * {@inheritdoc}
   */
  public function getOption($name) {
    return isset($this->options[$name]) ? $this->options[$name] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function hasThumbnails() {
    return !empty($this
      ->getOption('thumbnail_position'));
  }

  /**
   * {@inheritdoc}
   */
  public function hasAutoPlay() {
    return !empty($this
      ->getOption('autoplay'));
  }

  /**
   * {@inheritdoc}
   */
  public function allowFullScreen() {
    return !empty($this->options['advanced']['full_screen']);
  }

  /**
   * {@inheritdoc}
   */
  public function toOptionSet() {
    $optionset = [
      'width' => $this
        ->getOption('width'),
      'visibleSize' => $this
        ->getOption('visible_size'),
      'forceSize' => $this
        ->getOption('force_size'),
      'height' => $this
        ->getOption('height'),
      'orientation' => $this
        ->getOption('orientation'),
      'buttons' => $this
        ->getOption('buttons') ? TRUE : FALSE,
      'fade' => $this
        ->getOption('transition') ? TRUE : FALSE,
      'arrows' => $this
        ->getOption('arrows') ? TRUE : FALSE,
      'centerImage' => $this
        ->getOption('center_image') ? TRUE : FALSE,
      'allowScaleUp' => $this
        ->getOption('allow_scale_up') ? TRUE : FALSE,
      'autoHeight' => $this
        ->getOption('auto_height') ? TRUE : FALSE,
      'startSlide' => (int) $this
        ->getOption('start_slide'),
      'shuffle' => $this
        ->getOption('shuffle') ? TRUE : FALSE,
      'loop' => $this
        ->getOption('loop') ? TRUE : FALSE,
      'autoplay' => $this
        ->hasAutoPlay() ? TRUE : FALSE,
      'slideDistance' => (int) $this
        ->getOption('slide_distance'),
      'keyboard' => $this
        ->getOption('keyboard') ? TRUE : FALSE,
      'fullScreen' => $this
        ->allowFullScreen() ? TRUE : FALSE,
      'updateHash' => $this
        ->getOption('update_hash') ? TRUE : FALSE,
      'waitForLayers' => $this
        ->getOption('wait_for_layers') ? TRUE : FALSE,
      'autoScaleLayers' => $this
        ->getOption('auto_scale_layers') ? TRUE : FALSE,
    ];
    if ($this
      ->hasAutoPlay()) {
      $optionset['autoplayDelay'] = (int) $this
        ->getOption('autoplay_delay');
      $optionset['autoplayDirection'] = $this
        ->getOption('autoplay_direction');
      $optionset['autoplayOnHover'] = $this
        ->getOption('autoplay_on_hover');
    }
    if ($this
      ->allowFullScreen()) {
      $optionset['fadeFullScreen'] = $this
        ->getOption('fade_full_screen') ? TRUE : FALSE;
    }
    if ($this
      ->hasThumbnails()) {
      $optionset['thumbnailWidth'] = (int) $this
        ->getOption('thumbnail_width');
      $optionset['thumbnailHeight'] = (int) $this
        ->getOption('thumbnail_height');
      $optionset['thumbnailsPosition'] = $this
        ->getOption('thumbnail_position');
      $optionset['thumbnailPointer'] = $this
        ->getOption('thumbnail_pointer') ? TRUE : FALSE;
      $optionset['thumbnailArrows'] = $this
        ->getOption('thumbnail_arrows') ? TRUE : FALSE;
      if ($optionset['thumbnailArrows']) {
        $optionset['fadeThumbnailArrows'] = $this
          ->getOption('fade_thumbnail_arrows') ? TRUE : FALSE;
      }
    }
    return $optionset;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(array $values = []) {
    return parent::create($values);
  }

}

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::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::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
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
SliderPro::$id	protected	property	The Fslider pro optionset ID.
SliderPro::$label	protected	property	The slider pro optionset label.
SliderPro::$options	protected	property	The slider pro optionset options.
SliderPro::allowFullScreen	public	function	Checks if option set has full screen mode. Overrides SliderProInterface::allowFullScreen
SliderPro::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityBase::create
SliderPro::getOption	public	function	Returns the value of a slider pro library option. Overrides SliderProInterface::getOption
SliderPro::getOptions	public	function	Returns the array of slider pro library options. Overrides SliderProInterface::getOptions
SliderPro::hasAutoPlay	public	function	Checks if option set has autoplay. Overrides SliderProInterface::hasAutoPlay
SliderPro::hasThumbnails	public	function	Checks if option set requires thumbnails. Overrides SliderProInterface::hasThumbnails
SliderPro::setOptions	public	function	Sets the slider pro library options array. Overrides SliderProInterface::setOptions
SliderPro::toOptionSet	public	function	Returns an array formatted to use as JS option set. Overrides SliderProInterface::toOptionSet
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 SliderPro in Slider Pro 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation