class FileVideoFormatter

Same name in other branches
  1. 8.9.x core/modules/file/src/Plugin/Field/FieldFormatter/FileVideoFormatter.php \Drupal\file\Plugin\Field\FieldFormatter\FileVideoFormatter
  2. 10 core/modules/file/src/Plugin/Field/FieldFormatter/FileVideoFormatter.php \Drupal\file\Plugin\Field\FieldFormatter\FileVideoFormatter
  3. 11.x core/modules/file/src/Plugin/Field/FieldFormatter/FileVideoFormatter.php \Drupal\file\Plugin\Field\FieldFormatter\FileVideoFormatter

Plugin implementation of the 'file_video' formatter.

Plugin annotation


@FieldFormatter(
  id = "file_video",
  label = @Translation("Video"),
  description = @Translation("Display the file using an HTML5 video tag."),
  field_types = {
    "file"
  }
)

Hierarchy

Expanded class hierarchy of FileVideoFormatter

File

core/modules/file/src/Plugin/Field/FieldFormatter/FileVideoFormatter.php, line 19

Namespace

Drupal\file\Plugin\Field\FieldFormatter
View source 
class FileVideoFormatter extends FileMediaFormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public static function getMediaType() {
        return 'video';
    }
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'muted' => FALSE,
            'width' => 640,
            'height' => 480,
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        return parent::settingsForm($form, $form_state) + [
            'muted' => [
                '#title' => $this->t('Muted'),
                '#type' => 'checkbox',
                '#default_value' => $this->getSetting('muted'),
            ],
            'width' => [
                '#type' => 'number',
                '#title' => $this->t('Width'),
                '#default_value' => $this->getSetting('width'),
                '#size' => 5,
                '#maxlength' => 5,
                '#field_suffix' => $this->t('pixels'),
                '#min' => 0,
                '#required' => TRUE,
            ],
            'height' => [
                '#type' => 'number',
                '#title' => $this->t('Height'),
                '#default_value' => $this->getSetting('height'),
                '#size' => 5,
                '#maxlength' => 5,
                '#field_suffix' => $this->t('pixels'),
                '#min' => 0,
                '#required' => TRUE,
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = parent::settingsSummary();
        $summary[] = $this->t('Muted: %muted', [
            '%muted' => $this->getSetting('muted') ? $this->t('yes') : $this->t('no'),
        ]);
        $summary[] = $this->t('Size: %width x %height pixels', [
            '%width' => $this->getSetting('width'),
            '%height' => $this->getSetting('height'),
        ]);
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function prepareAttributes(array $additional_attributes = []) {
        return parent::prepareAttributes([
            'muted',
        ])->setAttribute('width', $this->getSetting('width'))
            ->setAttribute('height', $this->getSetting('height'));
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being
viewed. 		Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess 1
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
FileMediaFormatterBase::getHtmlTag protected function Gets the HTML tag for the formatter.
FileMediaFormatterBase::getSourceFiles protected function Gets source files with attributes.
FileMediaFormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
FileMediaFormatterBase::mimeTypeApplies protected static function Check if given MIME type applies to the media type of the formatter.
FileMediaFormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FileVideoFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides FileMediaFormatterBase::defaultSettings
FileVideoFormatter::getMediaType public static function Gets the applicable media type for a formatter. Overrides FileMediaFormatterInterface::getMediaType
FileVideoFormatter::prepareAttributes protected function Prepare the attributes according to the settings. Overrides FileMediaFormatterBase::prepareAttributes
FileVideoFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FileMediaFormatterBase::settingsForm
FileVideoFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FileMediaFormatterBase::settingsSummary
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 13
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::__construct public function Constructs a FormatterBase object. 13
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.