class FilefieldSource in FileField Sources 8

Defines a Search API processor annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\filefield_sources\Annotation\FilefieldSource

5 classes are annotated with FilefieldSource

Attach in src/Plugin/FilefieldSource/Attach.php

A FileField source plugin to allow use of files within a server directory.

Clipboard in src/Plugin/FilefieldSource/Clipboard.php

A FileField source plugin to allow transfer of files through the clipboard.

Imce in src/Plugin/FilefieldSource/Imce.php

A FileField source plugin to allow referencing of files from IMCE.

Reference in src/Plugin/FilefieldSource/Reference.php

A FileField source plugin to allow referencing of existing files.

Remote in src/Plugin/FilefieldSource/Remote.php

A FileField source plugin to allow downloading a file from a remote server.

File

src/Annotation/FilefieldSource.php, line 12

Namespace

Drupal\filefield_sources\Annotation

class FilefieldSource extends Plugin {

  /**
   * The file field source plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The name of the file field source plugin.
   *
   * It will be displayed in a select list.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $name;

  /**
   * The human-readable name of the file field source plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The description of the file field source plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The weight of file field source plugin.
   *
   * @var int
   */
  public $weight;

}

Members

Name	Modifiers	Type	Description	Overrides
FilefieldSource::$description	public	property	The description of the file field source plugin.
FilefieldSource::$id	public	property	The file field source plugin ID.
FilefieldSource::$label	public	property	The human-readable name of the file field source plugin.
FilefieldSource::$name	public	property	The name of the file field source plugin.
FilefieldSource::$weight	public	property	The weight of file field source plugin.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2