interface FieldPermissionsServiceInterface in Field Permissions 8

Implement FieldPermission Interface.

Hierarchy

• interface \Drupal\field_permissions\FieldPermissionsServiceInterface

1 file declares its use of FieldPermissionsServiceInterface

FieldPermissionsController.php in src/Controller/FieldPermissionsController.php

File

src/FieldPermissionsServiceInterface.php, line 13

Namespace

Drupal\field_permissions

interface FieldPermissionsServiceInterface {

  /**
   * Obtain the list of field permissions.
   *
   * @param string $field_label
   *   The human readable name of the field to use when constructing permission
   *   names. Usually this will be derived from one or more of the field
   *   instance labels.
   *
   * @return array
   *   An array keyed by the permission machine name, with label and description
   *   keys. Note that this machine name doesn't include the field name.
   *
   * @todo This is really only releavant to the custom field permission type
   *   plugin. However, since it is used in the report page, it would be
   *   difficult to abstract down to the plugin level the way the report
   *   currently works.
   */
  public static function getList($field_label = '');

  /**
   * Get all field permissions keyed by role ID.
   *
   * @return array
   *   An array of permission information keyed by role ID.
   */
  public function getPermissionsByRole();

  /**
   * Returns permissions for all fields that are using custom permissions.
   *
   * This is suitable for use as a permission callback.
   *
   * @return array
   *   An array of all permissions for all fields that implement the custom
   *   permission type.
   */
  public function getAllPermissions();

  /**
   * Get the permission type for a given field.
   *
   * @param \Drupal\field\FieldStorageConfigInterface $field
   *   The field to return permissions for.
   */
  public function fieldGetPermissionType(FieldStorageConfigInterface $field);

  /**
   * Field is attached to comment entity.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   Fields to get permissions.
   *
   * @return bool
   *   TRUE if in a comment entity.
   */
  public static function isCommentField(FieldDefinitionInterface $field_definition);

  /**
   * Get access for field by operations and account permisisons.
   *
   * @param string $operation
   *   String operation on field.
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The entity field object on which to check access.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account to get permissions.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   Fields to get permissions.
   */
  public function getFieldAccess($operation, FieldItemListInterface $items, AccountInterface $account, FieldDefinitionInterface $field_definition);

}

Members

Name	Modifiers	Type	Description	Overrides
FieldPermissionsServiceInterface::fieldGetPermissionType	public	function	Get the permission type for a given field.	1
FieldPermissionsServiceInterface::getAllPermissions	public	function	Returns permissions for all fields that are using custom permissions.	1
FieldPermissionsServiceInterface::getFieldAccess	public	function	Get access for field by operations and account permisisons.	1
FieldPermissionsServiceInterface::getList	public static	function	Obtain the list of field permissions.	1
FieldPermissionsServiceInterface::getPermissionsByRole	public	function	Get all field permissions keyed by role ID.	1
FieldPermissionsServiceInterface::isCommentField	public static	function	Field is attached to comment entity.	1