Version 1

[yaffs-website] / web / modules / contrib / media_entity / src / MediaTypeInterface.php

diff --git a/web/modules/contrib/media_entity/src/MediaTypeInterface.php b/web/modules/contrib/media_entity/src/MediaTypeInterface.php
new file mode 100644 (file)
index 0000000..2a171c2
--- /dev/null
+++ b/web/modules/contrib/media_entity/src/MediaTypeInterface.php
@@ -0,0 +1,88 @@
+<?php
+
+namespace Drupal\media_entity;
+
+use Drupal\Component\Plugin\PluginInspectionInterface;
+use Drupal\Component\Plugin\ConfigurablePluginInterface;
+use Drupal\Core\Plugin\PluginFormInterface;
+
+/**
+ * Defines the interface for media types.
+ */
+interface MediaTypeInterface extends PluginInspectionInterface, ConfigurablePluginInterface, PluginFormInterface {
+
+  /**
+   * Returns the display label.
+   *
+   * @return string
+   *   The display label.
+   */
+  public function label();
+
+  /**
+   * Gets list of fields provided by this plugin.
+   *
+   * @return array
+   *   Associative array with field names as keys and descriptions as values.
+   */
+  public function providedFields();
+
+  /**
+   * Gets a media-related field/value.
+   *
+   * @param MediaInterface $media
+   *   Media object.
+   * @param string $name
+   *   Name of field to fetch.
+   *
+   * @return mixed
+   *   Field value or FALSE if data unavailable.
+   */
+  public function getField(MediaInterface $media, $name);
+
+  /**
+   * Attaches type-specific constraints to media.
+   *
+   * @param MediaInterface $media
+   *   Media entity.
+   */
+  public function attachConstraints(MediaInterface $media);
+
+  /**
+   * Gets thumbnail image.
+   *
+   * Media type plugin is responsible for returning URI of the generic thumbnail
+   * if no other is available. This functions should always return a valid URI.
+   *
+   * @param MediaInterface $media
+   *   Media.
+   *
+   * @return string
+   *   URI of the thumbnail.
+   */
+  public function thumbnail(MediaInterface $media);
+
+  /**
+   * Gets the default thumbnail image.
+   *
+   * @return string
+   *   Uri of the default thumbnail image.
+   */
+  public function getDefaultThumbnail();
+
+  /**
+   * Provide a default name for the media.
+   *
+   * Plugins defining media bundles are suggested to override this method and
+   * provide a default name, to be used when there is no user-defined label
+   * available.
+   *
+   * @param \Drupal\media_entity\MediaInterface $media
+   *   The media object.
+   *
+   * @return string
+   *   The string that should be used as default media name.
+   */
+  public function getDefaultName(MediaInterface $media);
+
+}