Defines a Source plugin annotation object.
Expanded class hierarchy of SourcePlugin
class SourcePlugin extends Plugin {
/**
* The plugin ID.
*
* @var string
*/
public $id;
/**
* The human-readable name of the source.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $label;
/**
* A short description of the source.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $description;
/**
* The name of the source plugin class.
*
* This is not provided manually, it will be added by the discovery mechanism.
*
* @var string
*/
public $class;
/**
* An array with default values for this source.
*
* @var array
*/
public $default_settings = array();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SourcePlugin:: |
public | property | The name of the source plugin class. | |
SourcePlugin:: |
public | property | An array with default values for this source. | |
SourcePlugin:: |
public | property | A short description of the source. | |
SourcePlugin:: |
public | property | The plugin ID. | |
SourcePlugin:: |
public | property | The human-readable name of the source. |