class SoundcloudEmbedFormatter in Media entity Soundcloud 8

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldFormatter/SoundcloudEmbedFormatter.php \Drupal\media_entity_soundcloud\Plugin\Field\FieldFormatter\SoundcloudEmbedFormatter
3.x src/Plugin/Field/FieldFormatter/SoundcloudEmbedFormatter.php \Drupal\media_entity_soundcloud\Plugin\Field\FieldFormatter\SoundcloudEmbedFormatter

Plugin implementation of the 'soundcloud_embed' formatter.

Plugin annotation


@FieldFormatter(
  id = "soundcloud_embed",
  label = @Translation("Soundcloud embed"),
  field_types = {
    "link", "string", "string_long"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\media_entity_soundcloud\Plugin\Field\FieldFormatter\SoundcloudEmbedFormatter

Expanded class hierarchy of SoundcloudEmbedFormatter

File

src/Plugin/Field/FieldFormatter/SoundcloudEmbedFormatter.php, line 22

Namespace

Drupal\media_entity_soundcloud\Plugin\Field\FieldFormatter

View source

class SoundcloudEmbedFormatter extends FormatterBase {

  /**
   * @inheritDoc
   */
  public static function defaultSettings() {
    return array(
      'type' => 'visual',
      'width' => '100%',
      'height' => '450px',
      'options' => [],
    ) + parent::defaultSettings();
  }

  /**
   * @inheritDoc
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['type'] = [
      '#title' => $this
        ->t('Type'),
      '#type' => 'select',
      '#options' => [
        'visual' => $this
          ->t('Visual'),
        'classic' => $this
          ->t('Classic'),
      ],
      '#default_value' => $this
        ->getSetting('type'),
      '#description' => $this
        ->t('The type of embed.'),
    ];
    $elements['width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this
        ->getSetting('width'),
      '#min' => 1,
      '#required' => TRUE,
      '#description' => $this
        ->t('Width of embedded player.'),
    ];
    $elements['height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this
        ->getSetting('height'),
      '#min' => 1,
      '#required' => TRUE,
      '#description' => $this
        ->t('Height of embedded player. Suggested values: 450px for the visual type and 166px for classic.'),
    ];
    $elements['options'] = [
      '#title' => $this
        ->t('Options'),
      '#type' => 'checkboxes',
      '#default_value' => $this
        ->getSetting('options'),
      '#options' => $this
        ->getEmbedOptions(),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [
      $this
        ->t('Type: @type', [
        '@type' => $this
          ->getSetting('type'),
      ]),
      $this
        ->t('Width: @width', [
        '@width' => $this
          ->getSetting('width'),
      ]),
      $this
        ->t('Height: @height', [
        '@height' => $this
          ->getSetting('height'),
      ]),
    ];
    $options = $this
      ->getSetting('options');
    if (count($options)) {
      $summary[] = $this
        ->t('Options: @options', [
        '@options' => implode(', ', array_intersect_key($this
          ->getEmbedOptions(), array_flip($this
          ->getSetting('options')))),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    /** @var \Drupal\media_entity\MediaInterface $media_entity */
    $media_entity = $items
      ->getEntity();
    $element = [];
    if (($type = $media_entity
      ->getType()) && $type instanceof Soundcloud) {

      /** @var MediaTypeInterface $item */
      foreach ($items as $delta => $item) {
        if ($track_id = $type
          ->getField($media_entity, 'track_id')) {
          $element[$delta] = [
            '#theme' => 'media_soundcloud_embed',
            '#track_id' => $track_id,
            '#width' => $this
              ->getSetting('width'),
            '#height' => $this
              ->getSetting('height'),
            '#type' => $this
              ->getSetting('type'),
            '#options' => $this
              ->getSetting('options'),
          ];
        }
      }
    }
    return $element;
  }

  /**
   * Returns an array of options for the embedded player.
   *
   * @return array
   */
  protected function getEmbedOptions() {
    return [
      'auto_play' => $this
        ->t('Autoplay'),
      'hide_related' => $this
        ->t('Hide related'),
      'show_comments' => $this
        ->t('Show comments'),
      'show_user' => $this
        ->t('Show user'),
      'show_reposts' => $this
        ->t('Show reposts'),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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		1
DependencySerializationTrait::__wakeup	public	function		2
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
SoundcloudEmbedFormatter::defaultSettings	public static	function	@inheritDoc Overrides PluginSettingsBase::defaultSettings
SoundcloudEmbedFormatter::getEmbedOptions	protected	function	Returns an array of options for the embedded player.
SoundcloudEmbedFormatter::settingsForm	public	function	@inheritDoc Overrides FormatterBase::settingsForm
SoundcloudEmbedFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
SoundcloudEmbedFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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.

You are here

class SoundcloudEmbedFormatter in Media entity Soundcloud 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation