Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Entity\EntityAccessControlHandlerInterface.
6	*/
7
8	namespace Drupal\Core\Entity;
9
10	use Drupal\Core\Field\FieldItemListInterface;
11	use Drupal\Core\Extension\ModuleHandlerInterface;
12	use Drupal\Core\Field\FieldDefinitionInterface;
13	use Drupal\Core\Session\AccountInterface;
14
15	/**
16	* Defines an interface for entity access control handlers.
17	*/
18	interface EntityAccessControlHandlerInterface {
19
20	/**
21	* Checks access to an operation on a given entity or entity translation.
22	*
23	* Use \Drupal\Core\Entity\EntityAccessControlHandlerInterface::createAccess()
24	* to check access to create an entity.
25	*
26	* @param \Drupal\Core\Entity\EntityInterface $entity
27	* The entity for which to check access.
28	* @param string $operation
29	* The operation access should be checked for.
30	* Usually one of "view", "update" or "delete".
31	* @param \Drupal\Core\Session\AccountInterface $account
32	* (optional) The user session for which to check access, or NULL to check
33	* access for the current user. Defaults to NULL.
34	* @param bool $return_as_object
35	* (optional) Defaults to FALSE.
36	*
37	* @return bool\|\Drupal\Core\Access\AccessResultInterface
38	* The access result. Returns a boolean if $return_as_object is FALSE (this
39	* is the default) and otherwise an AccessResultInterface object.
40	* When a boolean is returned, the result of AccessInterface::isAllowed() is
41	* returned, i.e. TRUE means access is explicitly allowed, FALSE means
42	* access is either explicitly forbidden or "no opinion".
43	*/
44	public function access(EntityInterface $entity, $operation, AccountInterface $account = NULL, $return_as_object = FALSE);
45
46	/**
47	* Checks access to create an entity.
48	*
49	* @param string $entity_bundle
50	* (optional) The bundle of the entity. Required if the entity supports
51	* bundles, defaults to NULL otherwise.
52	* @param \Drupal\Core\Session\AccountInterface $account
53	* (optional) The user session for which to check access, or NULL to check
54	* access for the current user. Defaults to NULL.
55	* @param array $context
56	* (optional) An array of key-value pairs to pass additional context when
57	* needed.
58	* @param bool $return_as_object
59	* (optional) Defaults to FALSE.
60	*
61	* @return bool\|\Drupal\Core\Access\AccessResultInterface
62	* The access result. Returns a boolean if $return_as_object is FALSE (this
63	* is the default) and otherwise an AccessResultInterface object.
64	* When a boolean is returned, the result of AccessInterface::isAllowed() is
65	* returned, i.e. TRUE means access is explicitly allowed, FALSE means
66	* access is either explicitly forbidden or "no opinion".
67	*/
68	public function createAccess($entity_bundle = NULL, AccountInterface $account = NULL, array $context = array(), $return_as_object = FALSE);
69
70	/**
71	* Clears all cached access checks.
72	*/
73	public function resetCache();
74
75	/**
76	* Sets the module handler for this access control handler.
77	*
78	* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
79	* The module handler.
80	*
81	* @return $this
82	*/
83	public function setModuleHandler(ModuleHandlerInterface $module_handler);
84
85	/**
86	* Checks access to an operation on a given entity field.
87	*
88	* This method does not determine whether access is granted to the entity
89	* itself, only the specific field. Callers are responsible for ensuring that
90	* entity access is also respected, for example by using
91	* \Drupal\Core\Entity\EntityAccessControlHandlerInterface::access().
92	*
93	* @param string $operation
94	* The operation access should be checked for.
95	* Usually one of "view" or "edit".
96	* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
97	* The field definition.
98	* @param \Drupal\Core\Session\AccountInterface $account
99	* (optional) The user session for which to check access, or NULL to check
100	* access for the current user. Defaults to NULL.
101	* @param \Drupal\Core\Field\FieldItemListInterface $items
102	* (optional) The field values for which to check access, or NULL if access
103	* is checked for the field definition, without any specific value
104	* available. Defaults to NULL.
105	* @param bool $return_as_object
106	* (optional) Defaults to FALSE.
107	*
108	* @return bool\|\Drupal\Core\Access\AccessResultInterface
109	* The access result. Returns a boolean if $return_as_object is FALSE (this
110	* is the default) and otherwise an AccessResultInterface object.
111	* When a boolean is returned, the result of AccessInterface::isAllowed() is
112	* returned, i.e. TRUE means access is explicitly allowed, FALSE means
113	* access is either explicitly forbidden or "no opinion".
114	*
115	* @see \Drupal\Core\Entity\EntityAccessControlHandlerInterface::access()
116	*/
117	public function fieldAccess($operation, FieldDefinitionInterface $field_definition, AccountInterface $account = NULL, FieldItemListInterface $items = NULL, $return_as_object = FALSE);
118
119	}