Commit cb846b87 authored by catch's avatar catch

Issue #2982719 by seanB, phenaproxima, xjm: Document the MediaType config entity properties

parent ce816c7d
......@@ -100,6 +100,8 @@ class MediaType extends ConfigEntityBundleBase implements MediaTypeInterface, En
* Whether thumbnail downloads are queued.
*
* @var bool
*
* @see \Drupal\media\MediaTypeInterface::thumbnailDownloadsAreQueued()
*/
protected $queue_thumbnail_downloads = FALSE;
......@@ -113,7 +115,15 @@ class MediaType extends ConfigEntityBundleBase implements MediaTypeInterface, En
/**
* The media source configuration.
*
* A media source can provide a configuration form with source plugin-specific
* configuration settings, which must at least include a source_field element
* containing a the name of the source field for the media type. The source
* configuration is defined by, and used to load, the source plugin. See
* \Drupal\media\MediaTypeInterface for an explanation of media sources.
*
* @var array
*
* @see \Drupal\media\MediaTypeInterface::getSource()
*/
protected $source_configuration = [];
......@@ -125,9 +135,11 @@ class MediaType extends ConfigEntityBundleBase implements MediaTypeInterface, En
protected $sourcePluginCollection;
/**
* Field map. Fields provided by type plugin to be stored as entity fields.
* The metadata field map.
*
* @var array
*
* @see \Drupal\media\MediaTypeInterface::getFieldMap()
*/
protected $field_map = [];
......
......@@ -35,6 +35,10 @@ interface MediaTypeInterface extends ConfigEntityInterface, EntityDescriptionInt
/**
* Returns whether thumbnail downloads are queued.
*
* When using remote media sources, the thumbnail generation could be a slow
* process. Using a queue allows for this process to be handled in the
* background.
*
* @return bool
* TRUE if thumbnails are queued for download later, FALSE if they should be
* downloaded now.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment