Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/shortcut/src/ShortcutSetStorageInterface.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\shortcut\ShortcutSetStorageInterface.
6	*/
7
8	namespace Drupal\shortcut;
9
10	use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
11	use Drupal\Core\Session\AccountInterface;
12
13	/**
14	* Defines an interface for shortcut_set entity storage classes.
15	*/
16	interface ShortcutSetStorageInterface extends ConfigEntityStorageInterface {
17
18	/**
19	* Assigns a user to a particular shortcut set.
20	*
21	* @param \Drupal\shortcut\ShortcutSetInterface $shortcut_set
22	* An object representing the shortcut set.
23	* @param $account
24	* A user account that will be assigned to use the set.
25	*/
26	public function assignUser(ShortcutSetInterface $shortcut_set, $account);
27
28	/**
29	* Unassigns a user from any shortcut set they may have been assigned to.
30	*
31	* The user will go back to using whatever default set applies.
32	*
33	* @param $account
34	* A user account that will be removed from the shortcut set assignment.
35	*
36	* @return bool
37	* TRUE if the user was previously assigned to a shortcut set and has been
38	* successfully removed from it. FALSE if the user was already not assigned
39	* to any set.
40	*/
41	public function unassignUser($account);
42
43	/**
44	* Delete shortcut sets assigned to users.
45	*
46	* @param \Drupal\shortcut\ShortcutSetInterface $entity
47	* Delete the user assigned sets belonging to this shortcut.
48	*/
49	public function deleteAssignedShortcutSets(ShortcutSetInterface $entity);
50
51	/**
52	* Get the name of the set assigned to this user.
53	*
54	* @param \Drupal\user\Entity\User
55	* The user account.
56	*
57	* @return string
58	* The name of the shortcut set assigned to this user.
59	*/
60	public function getAssignedToUser($account);
61
62	/**
63	* Get the number of users who have this set assigned to them.
64	*
65	* @param \Drupal\shortcut\ShortcutSetInterface $shortcut_set
66	* The shortcut to count the users assigned to.
67	*
68	* @return int
69	* The number of users who have this set assigned to them.
70	*/
71	public function countAssignedUsers(ShortcutSetInterface $shortcut_set);
72
73	/**
74	* Gets the default shortcut set for a given user account.
75	*
76	* @param \Drupal\Core\Session\AccountInterface $account
77	* The user account whose default shortcut set will be returned.
78	*
79	* @return \Drupal\shortcut\ShortcutSetInterface
80	* An object representing the default shortcut set.
81	*/
82	public function getDefaultSet(AccountInterface $account);
83
84	}