class FieldPermissionType in Field Permissions 8.2

Defines a field permission type plugin.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\field_permissions\Annotation\FieldPermissionType

1 file declares its use of FieldPermissionType

Manager.php in src/Plugin/FieldPermissionType/Manager.php

3 classes are annotated with FieldPermissionType

CustomAccess in src/Plugin/FieldPermissionType/CustomAccess.php

Defines custom access for fields.

PrivateAccess in src/Plugin/FieldPermissionType/PrivateAccess.php

Defines a private field type.

TestAccess in tests/modules/field_permissions_test/src/Plugin/FieldPermissionType/TestAccess.php

A test field permission type plugin.

File

src/Annotation/FieldPermissionType.php, line 12

Namespace

Drupal\field_permissions\Annotation

class FieldPermissionType extends Plugin {

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

  /**
   * The human-readable title.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The permission type description.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The weight for ordering the plugins on the field settings page.
   *
   * @var int
   */
  public $weight;

}

Members

Name	Modifiers	Type	Description	Overrides
FieldPermissionType::$description	public	property	The permission type description.
FieldPermissionType::$id	public	property	The plugin ID.
FieldPermissionType::$title	public	property	The human-readable title.
FieldPermissionType::$weight	public	property	The weight for ordering the plugins on the field settings page.
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