Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/node/src/NodeAccessControlHandlerInterface.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	* @file
4	* Contains \Drupal\node\NodeAccessControlHandlerInterface.
5	*/
6
7	namespace Drupal\node;
8
9	use Drupal\Core\Session\AccountInterface;
10
11	/**
12	* Node specific entity access control methods.
13	*
14	* @ingroup node_access
15	*/
16	interface NodeAccessControlHandlerInterface {
17
18	/**
19	* Gets the list of node access grants.
20	*
21	* This function is called to check the access grants for a node. It collects
22	* all node access grants for the node from hook_node_access_records()
23	* implementations, allows these grants to be altered via
24	* hook_node_access_records_alter() implementations, and returns the grants to
25	* the caller.
26	*
27	* @param \Drupal\node\NodeInterface $node
28	* The $node to acquire grants for.
29	*
30	* @return array $grants
31	* The access rules for the node.
32	*/
33	public function acquireGrants(NodeInterface $node);
34
35	/**
36	* Writes a list of grants to the database, deleting any previously saved ones.
37	*
38	* If a realm is provided, it will only delete grants from that realm, but it
39	* will always delete a grant from the 'all' realm. Modules that use node
40	* access can use this function when doing mass updates due to widespread
41	* permission changes.
42	*
43	* Note: Don't call this function directly from a contributed module. Call
44	* node_access_acquire_grants() instead.
45	*
46	* @param \Drupal\node\NodeInterface $node
47	* The node whose grants are being written.
48	* @param $delete
49	* (optional) If false, does not delete records. This is only for optimization
50	* purposes, and assumes the caller has already performed a mass delete of
51	* some form. Defaults to TRUE.
52	*/
53	public function writeGrants(NodeInterface $node, $delete = TRUE);
54
55	/**
56	* Creates the default node access grant entry on the grant storage.
57	*/
58	public function writeDefaultGrant();
59
60	/**
61	* Deletes all node access entries.
62	*/
63	public function deleteGrants();
64
65	/**
66	* Counts available node grants.
67	*
68	* @return int
69	* Returns the amount of node grants.
70	*/
71	public function countGrants();
72
73	/**
74	* Checks all grants for a given account.
75	*
76	* @param \Drupal\Core\Session\AccountInterface $account
77	* A user object representing the user for whom the operation is to be
78	* performed.
79	*
80	* @return int.
81	* Status of the access check.
82	*/
83	public function checkAllGrants(AccountInterface $account);
84
85	}