You are here

Home » API reference » JW Player 8 » Jw_player.php

class Jw_player in JW Player 8

Defines the JW Player preset entity.

Plugin annotation


@ConfigEntityType(
  id = "jw_player",
  label = @Translation("JW Player preset"),
  handlers = {
    "list_builder" = "Drupal\jw_player\Jw_playerListBuilder",
    "form" = {
      "add" = "Drupal\jw_player\Form\JwplayerPresetAdd",
      "edit" = "Drupal\jw_player\Form\JwplayerPresetAdd",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm"
    }
  },
  config_prefix = "preset",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  config_export = {
    "id",
    "label",
    "status",
    "description",
    "settings",
  },
  links = {
   "collection" = "/admin/config/media/jw_player",
   "edit-form" = "/admin/config/media/jw_player/{jw_player}",
   "delete-form" = "/admin/config/media/jw_player/{jw_player}/delete"
  }
)

Hierarchy

Expanded class hierarchy of Jw_player

4 files declare their use of Jw_player
JwPlayer.php in src/Element/JwPlayer.php
JwplayerFormatter.php in src/Plugin/Field/FieldFormatter/JwplayerFormatter.php
jw_player.install in ./jw_player.install
Install, update and uninstall functions for the JW Player module.
jw_player.module in ./jw_player.module
Adds a theme function which allows theme developers to use the JW Player.

File

src/Entity/Jw_player.php, line 44

Namespace

Drupal\jw_player\Entity
View source 
class Jw_player extends ConfigEntityBase implements Jw_playerInterface {
  use StringTranslationTrait;

  /**
   * The ID.
   *
   * @var string
   */
  public $id;

  /**
   * The Label.
   *
   * @var string
   */
  public $label;

  /**
   * Description.
   *
   * @var string
   */
  public $description;
  public $settings = array();

  /**
   * {@inheritdoc}
   */
  public function getSettings() {
    if (isset($this->settings['responsive']) && $this->settings['responsive']) {
      unset($this->settings['height']);
      $this->settings['width'] .= '%';
    }
    else {
      unset($this->settings['aspectratio']);
    }
    return $this->settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getSetting($key, $default = NULL) {
    $exists = NULL;
    $value =& NestedArray::getValue($this->settings, (array) $key, $exists);
    if (!$exists) {
      $value = $default;
    }
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsDisplay($format = 'string') {
    $summary = [];
    $preset_settings = $this
      ->getSettings();

    // Name and description.
    $summary['name'] = $this
      ->t('Preset: @name', [
      '@name' => $this
        ->label(),
    ]);
    if (!empty($this->description)) {
      $summary['description'] = $this
        ->t('Description: @desc', [
        '@desc' => $this->description,
      ]);
    }

    // Skin.
    if (!isset($preset_settings['preset_source']) || $preset_settings['preset_source'] == 'drupal') {
      $summary['source'] = $this
        ->t('Preset source: Drupal');
      if (!empty($preset_settings['skin'])) {
        $skin_label = $preset_settings['skin'];
        $summary['skin'] = $this
          ->t('Skin: @skin', [
          '@skin' => $skin_label,
        ]);
      }

      // Dimensions and stretching.
      if (isset($preset_settings['stretching'])) {
        switch ($preset_settings['stretching']) {
          case 'exactfit':
            $stretch = 'exact fit';
            break;
          case 'uniform':
            $stretch = 'uniform';
            break;
          case 'fill':
            $stretch = 'fill';
            break;
          default:
            $stretch = '';
            break;
        }
      }
      if (!empty($stretch)) {
        if (!empty($preset_settings['responsive'])) {
          $summary['dimensions'] = $this
            ->t('Dimensions: @width width (@aspect_ratio), @stretch', [
            '@width' => $preset_settings['width'],
            '@aspect_ratio' => $preset_settings['aspectratio'],
            '@stretch' => $stretch,
          ]);
        }
        else {
          $summary['dimensions'] = $this
            ->t('Dimensions: @widthx@height, @stretch', [
            '@width' => $preset_settings['width'],
            '@height' => $preset_settings['height'],
            '@stretch' => $stretch,
          ]);
        }
      }
      else {
        if (!empty($preset_settings['responsive'])) {
          $summary['dimensions'] = $this
            ->t('Dimensions: @width width (@aspect_ratio)', [
            '@width' => $preset_settings['width'],
            '@aspect_ratio' => $preset_settings['aspectratio'],
          ]);
        }
        else {
          $summary['dimensions'] = $this
            ->t('Dimensions: @widthx@height', [
            '@width' => $preset_settings['width'],
            '@height' => $preset_settings['height'],
          ]);
        }
      }

      // Enabled options.
      $enabled = [];
      if (!empty($preset_settings['autostart'])) {
        $enabled[] = $this
          ->t('Autostart');
      }
      if (!empty($preset_settings['mute'])) {
        $enabled[] = $this
          ->t('Mute');
      }
      if (isset($preset_settings['sharing']) && $preset_settings['sharing']) {
        $enabled[] = $this
          ->t('Sharing');
      }
      if (!empty($enabled)) {
        $enabled_string = implode(', ', $enabled);
        $summary['enabled'] = t('Enabled options: @enabled', [
          '@enabled' => $enabled_string,
        ]);
      }

      // Sharing sites.
      $sharing_weights = NULL;
      if (isset($preset_settings['sharing_sites']['sites'])) {
        foreach ($preset_settings['sharing_sites']['sites'] as $key => $value) {
          if ($value['enabled'] == TRUE) {
            $sharing_weights[$key] = $value['weight'];
          }
        }
        if ($sharing_weights) {
          asort($sharing_weights);
          $sharing_sites = jw_player_sharing_sites();
          $sharing_sorted = array_intersect_key($sharing_sites, $sharing_weights);
          $sharing_sorted_string = implode(', ', $sharing_sorted);
          $summary['sharing'] = $this
            ->t('Sharing sites: @sharing', [
            '@sharing' => $sharing_sorted_string,
          ]);
        }
      }
    }
    else {
      $summary['source'] = $this
        ->t('Preset source: JW Player');
    }
    return $format == 'string' ? implode('<br />', $summary) : $summary;
  }

}

Members

Namesort descending 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::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.
Jw_player::$description public property Description.
Jw_player::$id public property The ID.
Jw_player::$label public property The Label.
Jw_player::$settings public property
Jw_player::getSetting public function Returns a preset setting value for a specific key. Overrides Jw_playerInterface::getSetting
Jw_player::getSettings public function Returns the preset settings. Overrides Jw_playerInterface::getSettings
Jw_player::settingsDisplay public function Helper function to display JW Player preset settings. Overrides Jw_playerInterface::settingsDisplay
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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