Drush: commands/core/role.drush.inc Source File

  1. 7.x doxygen/html/role_8drush_8inc_source.html
  2. master doxygen/html/role_8drush_8inc_source.html
1 <?php
2 
4 
5 /**
6  * Implementation of hook_drush_help().
7  */
8 function role_drush_help($section) {
9  switch ($section) {
10  case 'meta:role:title':
11  return dt('Role commands');
12  case 'meta:role:summary':
13  return dt('Interact with the role system.');
14  }
15 }
16 
17 /**
18  * Implements hook_drush_help_alter().
19  */
20 function role_drush_help_alter(&$command) {
21  // Drupal 8+ has changed role names.
22  if (in_array($command['command'] , array('role-add-perm', 'role-add-perm', 'role-list')) && drush_drupal_major_version() >= 8) {
23  foreach ($command['examples'] as $key => $val) {
24  $newkey = str_replace(array('anonymous user', 'authenticated user'), array('anonymous', 'authenticated'), $key);
25  $command['examples'][$newkey] = $val;
26  unset($command['examples'][$key]);
27  }
28  }
29 }
30 
31 /**
32  * Implementation of hook_drush_command().
33  */
34 function role_drush_command() {
35  $items['role-create'] = array(
36  'description' => 'Create a new role.',
37  'examples' => array(
38  "drush role-create 'test role'" => "Create a new role 'test role' on D6 or D7; auto-assign the rid. On D8, 'test role' is the rid, and the human-readable name is set to 'Test role'.",
39  "drush role-create 'test role' 'Test role'" => "Create a new role with a machine name of 'test role', and a human-readable name of 'Test role'. On D6 and D7, behaves as the previous example."
40  ),
41  'arguments' => array(
42  'machine name' => 'The symbolic machine name for the role. Required.',
43  'human-readable name' => 'A descriptive name for the role. Optional; Drupal 8 only. Ignored in D6 and D7.',
44  ),
45  'aliases' => array('rcrt'),
46  );
47  $items['role-delete'] = array(
48  'description' => 'Delete a role.',
49  'examples' => array(
50  "drush role-delete 'test role'" => "Delete the role 'test role'.",
51  ),
52  'arguments' => array(
53  'machine name' => 'The symbolic machine name for the role. Required. In D6 and D7, this may also be a numeric role ID.',
54  ),
55  'aliases' => array('rdel'),
56  );
57  $items['role-add-perm'] = array(
58  'description' => 'Grant specified permission(s) to a role.',
59  'examples' => array(
60  "drush role-add-perm 'anonymous user' 'post comments'" => 'Allow anon users to post comments.',
61  "drush role-add-perm 'anonymous user' \"'post comments','access content'\"" => 'Allow anon users to post comments and access content.',
62  "drush role-add-perm 'authenticated user' --module=node" => 'Select a permission from "node" permissions to add to logged in users.'
63  ),
64  'arguments' => array(
65  'role' => 'The role to modify. Required.',
66  'permissions' => 'The list of permission to grant, delimited by commas. Required, unless the --module option is used.',
67  ),
68  'required-arguments' => 1,
69  'options' => array(
70  'module' => 'Select the permission to modify from an interactive list of all permissions available in the specified module.',
71  ),
72  'aliases' => array('rap'),
73  );
74 
75  $items['role-remove-perm'] = array(
76  'description' => 'Remove specified permission(s) from a role.',
77  'examples' => array(
78  "drush role-remove-perm 'anonymous user' 'access content'" => 'Hide content from anon users.',
79  ),
80  'arguments' => array(
81  'role' => 'The role to modify.',
82  'permissions' => 'The list of permission to grant, delimited by commas. Required, unless the --module option is used.',
83  ),
84  'required-arguments' => 1,
85  'options' => array(
86  'module' => 'Select the permission to modify from an interactive list of all permissions available in the specified module.',
87  ),
88  'aliases' => array('rmp'),
89  );
90 
91  $items['role-list'] = array(
92  'description' => 'Display a list of all roles defined on the system. If a role name is provided as an argument, then all of the permissions of that role will be listed. If a permission name is provided as an option, then all of the roles that have been granted that permission will be listed.',
93  'examples' => array(
94  "drush role-list --filter='administer nodes'" => 'Display a list of roles that have the administer nodes permission assigned.',
95  "drush role-list 'anonymous user'" => 'Display all of the permissions assigned to the anon user role.'
96  ),
97  'arguments' => array(
98  'role' => 'The role to list. Optional; if specified, lists all permissions assigned to that role. If no role is specified, lists all of the roles available on the system.',
99  ),
100  'options' => array(
101  'filter' => 'Limits the list of roles to only those that have been assigned the specified permission. Optional; may not be specified if a role argument is provided.',
102  ),
103  'outputformat' => array(
104  'default' => 'table',
105  'pipe-format' => 'list',
106  'field-labels' => array('rid' => 'ID', 'label' => 'Role Label', 'perm' => "Permission"),
107  'output-data-type' => 'format-table',
108  ),
109  'aliases' => array('rls'),
110  );
111 
112  return $items;
113 }
114 
115 /**
116  * Create the specified role
117  */
118 function drush_role_create($rid, $role_name = '') {
119  $role = drush_role_get_class();
120  $result = $role->role_create($rid, $role_name);
121  if ($result !== FALSE) {
122  drush_log(dt('Created "!role"', array('!role' => $rid)), 'success');
123  }
124  return $result;
125 }
126 
127 /**
128  * Create the specified role
129  */
130 function drush_role_delete($rid) {
131  $role = drush_role_get_class($rid);
132  if ($role === FALSE) {
133  return FALSE;
134  }
135  $result = $role->delete();
136  if ($result !== FALSE) {
137  drush_log(dt('Deleted "!role"', array('!role' => $rid)), 'success');
138  }
139  return $result;
140 }
141 
142 /**
143  * Add one or more permission(s) to the specified role.
144  *
145  * @param string $rid machine name for a role
146  * @param null|string $permissions machine names, delimited by commas.
147  *
148  * @return bool
149  */
150 function drush_role_add_perm($rid, $permissions = NULL) {
151  if (is_null($permissions)) {
152  // Assume --module is used thus inject a FALSE
153  $perms = array(FALSE);
154  }
155  else {
156  $perms = _convert_csv_to_array($permissions);
157  }
158  foreach($perms as $perm) {
159  $result = drush_role_perm('add', $rid, $perm);
160  if ($result !== FALSE) {
161  drush_log(dt('Added "!perm" to "!role"', array('!perm' => $perm, '!role' => $result->name)), 'success');
162  }
163  }
165  return $result;
166 }
167 
168 /**
169  * Remove permission(s) from the specified role.
170  *
171  * @param string $rid machine name for a role
172  * @param null|string $permissions machine names, delimited by commas.
173  *
174  * @return bool
175  */
176 function drush_role_remove_perm($rid, $permissions = NULL) {
177  if (is_null($permissions)) {
178  // Assume --module is used thus inject a FALSE
179  $perms = array(FALSE);
180  }
181  else {
182  $perms = _convert_csv_to_array($permissions);
183  }
184  foreach($perms as $perm) {
185  $result = drush_role_perm('remove', $rid, $perm);
186  if ($result !== FALSE) {
187  drush_log(dt('Removed "!perm" from "!role"', array('!perm' => $perm, '!role' => $result->name)), 'ok');
188  }
189  }
191  return $result;
192 }
193 
194 /**
195  * Implement permission add / remove operations.
196  *
197  * @param string $action 'add' | 'remove'
198  * @param string $rid
199  * @param string|null $permission
200  *
201  * @return bool|RoleBase
202  *
203  * @see drush_set_error()
204  */
205 function drush_role_perm($action, $rid, $permission = NULL) {
206  $role = drush_role_get_class($rid);
207  if (!$role) {
208  return FALSE;
209  }
210 
211  // If a permission wasn't provided, but the module option is specified,
212  // provide a list of permissions provided by that module.
213  if (!$permission && $module = drush_get_option('module', FALSE)) {
214  drush_include_engine('drupal', 'environment');
215  if (!drush_module_exists($module)) {
216  return drush_set_error('DRUSH_ROLE_ERROR', dt('!module not enabled!', array('!module' => $module)));
217  }
218  $module_perms = $role->getModulePerms($module);
219  if (empty($module_perms)) {
220  return drush_set_error('DRUSH_ROLE_NO_PERMISSIONS', dt('No permissions found for module !module', array('!module' => $module)));
221  }
222  $choice = drush_choice($module_perms, "Enter a number to choose which permission to $action.");
223  if ($choice === FALSE) {
224  return FALSE;
225  }
226  $permission = $module_perms[$choice];
227  }
228  else {
229  $permissions = $role->getAllModulePerms();
230  if (!in_array($permission, $permissions)) {
231  return drush_set_error(dt('Could not find the permission: !perm', array('!perm' => $permission)));
232  }
233  }
234 
235  $result = $role->{$action}($permission);
236  if ($result === FALSE) {
237  return FALSE;
238  }
239  return $role;
240 }
241 
242 /**
243  * Get core version specific Role handler class.
244  *
245  * @param string $role_name
246  * @return RoleBase
247  *
248  * @see drush_get_class().
249  */
250 function drush_role_get_class($role_name = DRUPAL_ANONYMOUS_RID) {
251  return drush_get_class('Drush\Role\Role', func_get_args());
252 }
253 
254 /**
255  * Displays a list of roles
256  */
257 function drush_role_list($rid = '') {
258  $result = array();
259  if (empty($rid)) {
261  // Get options passed.
262  $perm = drush_get_option('filter');
263  $roles = array();
264 
265  // Get all roles - if $perm is empty user_roles retrieves all roles.
266  $roles = user_roles(FALSE, $perm);
267  if (empty($roles)) {
268  return drush_set_error('DRUSH_NO_ROLES', dt("No roles found."));
269  }
270  foreach ($roles as $rid => $value) {
271  $role = drush_role_get_class($rid);
272  $result[$role->name] = array(
273  'rid' => $rid,
274  'label' => $role->name,
275  );
276  }
277  }
278  else {
279  drush_hide_output_fields(array('rid', 'label'));
280  $role = drush_role_get_class($rid);
281  if (!$role) {
282  return FALSE;
283  }
284  $perms = $role->getPerms();
285  foreach ($perms as $permission) {
286  $result[$permission] = array(
287  'perm' => $permission);
288  }
289  }
290  return $result;
291 }

File

doxygen/html/role_8drush_8inc_source.html
View source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Drush: commands/core/role.drush.inc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Drush
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_afac61274991793aa7e9133a8f4f291e.html">commands</a></li><li class="navelem"><a class="el" href="dir_5762b63965e3a68a35f77c23b4dd4668.html">core</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">role.drush.inc</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;&lt;?php</div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;use <a class="code" href="classDrush_1_1Role_1_1RoleBase.html">Drush\Role\RoleBase</a>;</div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Implementation of hook_drush_help().</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">function</span> role_drush_help($section) {</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;  <span class="keywordflow">switch</span> ($section) {</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;    <span class="keywordflow">case</span> <span class="stringliteral">&#39;meta:role:title&#39;</span>:</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Role commands&#39;</span>);</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;    <span class="keywordflow">case</span> <span class="stringliteral">&#39;meta:role:summary&#39;</span>:</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Interact with the role system.&#39;</span>);</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;  }</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;}</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * Implements hook_drush_help_alter().</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">function</span> role_drush_help_alter(&amp;$command) {</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;  <span class="comment">// Drupal 8+ has changed role names.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;  <span class="keywordflow">if</span> (in_array($command[<span class="stringliteral">&#39;command&#39;</span>] , array(<span class="stringliteral">&#39;role-add-perm&#39;</span>, <span class="stringliteral">&#39;role-add-perm&#39;</span>, <span class="stringliteral">&#39;role-list&#39;</span>)) &amp;&amp; <a class="code" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0">drush_drupal_major_version</a>() &gt;= 8) {</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="keywordflow">foreach</span> ($command[<span class="stringliteral">&#39;examples&#39;</span>] as $key =&gt; $val) {</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      $newkey = str_replace(array(<span class="stringliteral">&#39;anonymous user&#39;</span>, <span class="stringliteral">&#39;authenticated user&#39;</span>), array(<span class="stringliteral">&#39;anonymous&#39;</span>, <span class="stringliteral">&#39;authenticated&#39;</span>), $key);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;      $command[<span class="stringliteral">&#39;examples&#39;</span>][$newkey] = $val;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;      unset($command[<span class="stringliteral">&#39;examples&#39;</span>][$key]);</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    }</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;  }</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;}</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> * Implementation of hook_drush_command().</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">function</span> role_drush_command() {</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;  $items[<span class="stringliteral">&#39;role-create&#39;</span>] = array(</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Create a new role.&#39;</span>,</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;      <span class="stringliteral">&quot;drush role-create &#39;test role&#39;&quot;</span> =&gt; <span class="stringliteral">&quot;Create a new role &#39;test role&#39; on D6 or D7; auto-assign the rid. On D8, &#39;test role&#39; is the rid, and the human-readable name is set to &#39;Test role&#39;.&quot;</span>,</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;      <span class="stringliteral">&quot;drush role-create &#39;test role&#39; &#39;Test role&#39;&quot;</span> =&gt; <span class="stringliteral">&quot;Create a new role with a machine name of &#39;test role&#39;, and a human-readable name of &#39;Test role&#39;. On D6 and D7, behaves as the previous example.&quot;</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    ),</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="stringliteral">&#39;arguments&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;      <span class="stringliteral">&#39;machine name&#39;</span> =&gt; <span class="stringliteral">&#39;The symbolic machine name for the role. Required.&#39;</span>,</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;      <span class="stringliteral">&#39;human-readable name&#39;</span> =&gt; <span class="stringliteral">&#39;A descriptive name for the role. Optional; Drupal 8 only.  Ignored in D6 and D7.&#39;</span>,</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    ),</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;rcrt&#39;</span>),</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  );</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  $items[<span class="stringliteral">&#39;role-delete&#39;</span>] = array(</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Delete a role.&#39;</span>,</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;      <span class="stringliteral">&quot;drush role-delete &#39;test role&#39;&quot;</span> =&gt; <span class="stringliteral">&quot;Delete the role &#39;test role&#39;.&quot;</span>,</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    ),</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="stringliteral">&#39;arguments&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;      <span class="stringliteral">&#39;machine name&#39;</span> =&gt; <span class="stringliteral">&#39;The symbolic machine name for the role. Required.  In D6 and D7, this may also be a numeric role ID.&#39;</span>,</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    ),</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;rdel&#39;</span>),</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  );</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  $items[<span class="stringliteral">&#39;role-add-perm&#39;</span>] = array(</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Grant specified permission(s) to a role.&#39;</span>,</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;      <span class="stringliteral">&quot;drush role-add-perm &#39;anonymous user&#39; &#39;post comments&#39;&quot;</span> =&gt; <span class="stringliteral">&#39;Allow anon users to post comments.&#39;</span>,</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;      <span class="stringliteral">&quot;drush role-add-perm &#39;anonymous user&#39; \&quot;&#39;post comments&#39;,&#39;access content&#39;\&quot;&quot;</span> =&gt; <span class="stringliteral">&#39;Allow anon users to post comments and access content.&#39;</span>,</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;      <span class="stringliteral">&quot;drush role-add-perm &#39;authenticated user&#39; --module=node&quot;</span> =&gt; <span class="stringliteral">&#39;Select a permission from &quot;node&quot; permissions to add to logged in users.&#39;</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    ),</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="stringliteral">&#39;arguments&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;      <span class="stringliteral">&#39;role&#39;</span> =&gt; <span class="stringliteral">&#39;The role to modify.  Required.&#39;</span>,</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;      <span class="stringliteral">&#39;permissions&#39;</span> =&gt; <span class="stringliteral">&#39;The list of permission to grant, delimited by commas. Required, unless the --module option is used.&#39;</span>,</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    ),</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="stringliteral">&#39;required-arguments&#39;</span> =&gt; 1,</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="stringliteral">&#39;options&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;      <span class="stringliteral">&#39;module&#39;</span> =&gt; <span class="stringliteral">&#39;Select the permission to modify from an interactive list of all permissions available in the specified module.&#39;</span>,</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    ),</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;rap&#39;</span>),</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  );</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  $items[<span class="stringliteral">&#39;role-remove-perm&#39;</span>] = array(</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Remove specified permission(s) from a role.&#39;</span>,</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;      <span class="stringliteral">&quot;drush role-remove-perm &#39;anonymous user&#39; &#39;access content&#39;&quot;</span> =&gt; <span class="stringliteral">&#39;Hide content from anon users.&#39;</span>,</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    ),</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="stringliteral">&#39;arguments&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;      <span class="stringliteral">&#39;role&#39;</span> =&gt; <span class="stringliteral">&#39;The role to modify.&#39;</span>,</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;      <span class="stringliteral">&#39;permissions&#39;</span> =&gt; <span class="stringliteral">&#39;The list of permission to grant, delimited by commas. Required, unless the --module option is used.&#39;</span>,</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    ),</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="stringliteral">&#39;required-arguments&#39;</span> =&gt; 1,</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    <span class="stringliteral">&#39;options&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;      <span class="stringliteral">&#39;module&#39;</span> =&gt; <span class="stringliteral">&#39;Select the permission to modify from an interactive list of all permissions available in the specified module.&#39;</span>,</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    ),</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;rmp&#39;</span>),</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  );</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  $items[<span class="stringliteral">&#39;role-list&#39;</span>] = array(</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Display a list of all roles defined on the system.  If a role name is provided as an argument, then all of the permissions of that role will be listed.  If a permission name is provided as an option, then all of the roles that have been granted that permission will be listed.&#39;</span>,</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;      <span class="stringliteral">&quot;drush role-list --filter=&#39;administer nodes&#39;&quot;</span> =&gt; <span class="stringliteral">&#39;Display a list of roles that have the administer nodes permission assigned.&#39;</span>,</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;      <span class="stringliteral">&quot;drush role-list &#39;anonymous user&#39;&quot;</span> =&gt; <span class="stringliteral">&#39;Display all of the permissions assigned to the anon user role.&#39;</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    ),</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="stringliteral">&#39;arguments&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;      <span class="stringliteral">&#39;role&#39;</span> =&gt; <span class="stringliteral">&#39;The role to list.  Optional; if specified, lists all permissions assigned to that role.  If no role is specified, lists all of the roles available on the system.&#39;</span>,</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    ),</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    <span class="stringliteral">&#39;options&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;      <span class="stringliteral">&#39;filter&#39;</span> =&gt; <span class="stringliteral">&#39;Limits the list of roles to only those that have been assigned the specified permission. Optional; may not be specified if a role argument is provided.&#39;</span>,</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    ),</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    <span class="stringliteral">&#39;outputformat&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;      <span class="stringliteral">&#39;default&#39;</span> =&gt; <span class="stringliteral">&#39;table&#39;</span>,</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;      <span class="stringliteral">&#39;pipe-format&#39;</span> =&gt; <span class="stringliteral">&#39;list&#39;</span>,</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;      <span class="stringliteral">&#39;field-labels&#39;</span> =&gt; array(<span class="stringliteral">&#39;rid&#39;</span> =&gt; <span class="stringliteral">&#39;ID&#39;</span>, <span class="stringliteral">&#39;label&#39;</span> =&gt; <span class="stringliteral">&#39;Role Label&#39;</span>, <span class="stringliteral">&#39;perm&#39;</span> =&gt; <span class="stringliteral">&quot;Permission&quot;</span>),</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;      <span class="stringliteral">&#39;output-data-type&#39;</span> =&gt; <span class="stringliteral">&#39;format-table&#39;</span>,</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    ),</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;rls&#39;</span>),</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  );</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;  <span class="keywordflow">return</span> $items;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;}</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"> * Create the specified role</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="keyword">function</span> drush_role_create($rid, $role_name = <span class="stringliteral">&#39;&#39;</span>) {</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;  $role = drush_role_get_class();</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;  $result = $role-&gt;role_create($rid, $role_name);</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;  <span class="keywordflow">if</span> ($result !== FALSE) {</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    <a class="code" href="group__logging.html#gad820f489a93518301794ada4ff7816b6">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Created &quot;!role&quot;&#39;</span>, array(<span class="stringliteral">&#39;!role&#39;</span> =&gt; $rid)), <span class="stringliteral">&#39;success&#39;</span>);</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;  }</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;  <span class="keywordflow">return</span> $result;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;}</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"> * Create the specified role</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="keyword">function</span> drush_role_delete($rid) {</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;  $role = drush_role_get_class($rid);</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;  <span class="keywordflow">if</span> ($role === FALSE) {</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;  }</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;  $result = $role-&gt;delete();</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;  <span class="keywordflow">if</span> ($result !== FALSE) {</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;    <a class="code" href="group__logging.html#gad820f489a93518301794ada4ff7816b6">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Deleted &quot;!role&quot;&#39;</span>, array(<span class="stringliteral">&#39;!role&#39;</span> =&gt; $rid)), <span class="stringliteral">&#39;success&#39;</span>);</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;  }</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;  <span class="keywordflow">return</span> $result;</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;}</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> * Add one or more permission(s) to the specified role.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> * @param string $rid machine name for a role</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> * @param null|string $permissions machine names, delimited by commas.</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> * @return bool</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="keyword">function</span> drush_role_add_perm($rid, $permissions = NULL) {</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;  <span class="keywordflow">if</span> (is_null($permissions)) {</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;    <span class="comment">// Assume --module is used thus inject a FALSE</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;    $perms = array(FALSE);</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;  }</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;    $perms = <a class="code" href="drush_8inc.html#a6007ce294242d1f6e48cda703fbb8d3f">_convert_csv_to_array</a>($permissions);</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;  }</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;  <span class="keywordflow">foreach</span>($perms as $perm) {</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;    $result = drush_role_perm(<span class="stringliteral">&#39;add&#39;</span>, $rid, $perm);</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;    <span class="keywordflow">if</span> ($result !== FALSE) {</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;      <a class="code" href="group__logging.html#gad820f489a93518301794ada4ff7816b6">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Added &quot;!perm&quot; to &quot;!role&quot;&#39;</span>, array(<span class="stringliteral">&#39;!perm&#39;</span> =&gt; $perm, <span class="stringliteral">&#39;!role&#39;</span> =&gt; $result-&gt;name)), <span class="stringliteral">&#39;success&#39;</span>);</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;    }</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;  }</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;  drush_drupal_cache_clear_all();</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;  <span class="keywordflow">return</span> $result;</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;}</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment"> * Remove permission(s) from the specified role.</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"> * @param string $rid machine name for a role</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment"> * @param null|string $permissions machine names, delimited by commas.</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment"> * @return bool</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="keyword">function</span> drush_role_remove_perm($rid, $permissions = NULL) {</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;  <span class="keywordflow">if</span> (is_null($permissions)) {</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;    <span class="comment">// Assume --module is used thus inject a FALSE</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;    $perms = array(FALSE);</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;  }</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    $perms = <a class="code" href="drush_8inc.html#a6007ce294242d1f6e48cda703fbb8d3f">_convert_csv_to_array</a>($permissions);</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;  }</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;  <span class="keywordflow">foreach</span>($perms as $perm) {</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    $result = drush_role_perm(<span class="stringliteral">&#39;remove&#39;</span>, $rid, $perm);</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    <span class="keywordflow">if</span> ($result !== FALSE) {</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;      <a class="code" href="group__logging.html#gad820f489a93518301794ada4ff7816b6">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Removed &quot;!perm&quot; from &quot;!role&quot;&#39;</span>, array(<span class="stringliteral">&#39;!perm&#39;</span> =&gt; $perm, <span class="stringliteral">&#39;!role&#39;</span> =&gt; $result-&gt;name)), <span class="stringliteral">&#39;ok&#39;</span>);</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;    }</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;  }</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;  drush_drupal_cache_clear_all();</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;  <span class="keywordflow">return</span> $result;</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;}</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"> * Implement permission add / remove operations.</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment"> * @param string $action &#39;add&#39; | &#39;remove&#39;</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment"> * @param string $rid</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment"> * @param string|null $permission</span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment"> * @return bool|RoleBase</span></div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="comment"> * @see drush_set_error()</span></div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="keyword">function</span> drush_role_perm($action, $rid, $permission = NULL) {</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;  $role = drush_role_get_class($rid);</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;  <span class="keywordflow">if</span> (!$role) {</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;    <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;  }</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;  <span class="comment">// If a permission wasn&#39;t provided, but the module option is specified,</span></div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;  <span class="comment">// provide a list of permissions provided by that module.</span></div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;  <span class="keywordflow">if</span> (!$permission &amp;&amp; $module = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;module&#39;</span>, FALSE)) {</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;    <a class="code" href="engines_8inc.html#a91df31f18b0a1d05540ccaf85e6d9a88">drush_include_engine</a>(<span class="stringliteral">&#39;drupal&#39;</span>, <span class="stringliteral">&#39;environment&#39;</span>);</div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;    <span class="keywordflow">if</span> (!<a class="code" href="commands_2core_2drupal_2environment_8inc.html#a643d851fd8dc63ea2ce8cf67aa33098c">drush_module_exists</a>($module)) {</div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_ROLE_ERROR&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;!module not enabled!&#39;</span>, array(<span class="stringliteral">&#39;!module&#39;</span> =&gt; $module)));</div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;    }</div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;    $module_perms = $role-&gt;getModulePerms($module);</div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;    <span class="keywordflow">if</span> (empty($module_perms)) {</div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_ROLE_NO_PERMISSIONS&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;No permissions found for module !module&#39;</span>, array(<span class="stringliteral">&#39;!module&#39;</span> =&gt; $module)));</div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;    }</div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;    $choice = <a class="code" href="group__userinput.html#ga7e823bcd58051b17e6e5601340f0c784">drush_choice</a>($module_perms, <span class="stringliteral">&quot;Enter a number to choose which permission to $action.&quot;</span>);</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;    <span class="keywordflow">if</span> ($choice === FALSE) {</div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;      <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;    }</div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;    $permission = $module_perms[$choice];</div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;  }</div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;    $permissions = $role-&gt;getAllModulePerms();</div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;    <span class="keywordflow">if</span> (!in_array($permission, $permissions)) {</div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Could not find the permission: !perm&#39;</span>, array(<span class="stringliteral">&#39;!perm&#39;</span> =&gt; $permission)));</div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;    }</div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;  }</div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;</div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;  $result = $role-&gt;{$action}($permission);</div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;  <span class="keywordflow">if</span> ($result === FALSE) {</div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;    <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;  }</div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;  <span class="keywordflow">return</span> $role;</div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;}</div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment"> * Get core version specific Role handler class.</span></div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;<span class="comment"> * @param string $role_name</span></div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;<span class="comment"> * @return RoleBase</span></div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;<span class="comment"> * @see drush_get_class().</span></div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;<span class="keyword">function</span> drush_role_get_class($role_name = DRUPAL_ANONYMOUS_RID) {</div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="drush_8inc.html#ac0c5cc8dc02832fb068ca98efd0712c4">drush_get_class</a>(<span class="stringliteral">&#39;Drush\Role\Role&#39;</span>, func_get_args());</div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;}</div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment"> * Displays a list of roles</span></div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="keyword">function</span> drush_role_list($rid = <span class="stringliteral">&#39;&#39;</span>) {</div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;  $result = array();</div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;  <span class="keywordflow">if</span> (empty($rid)) {</div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;    <a class="code" href="outputformat_8drush_8inc.html#aa114eb117d61d2a796e638caf91f92d6">drush_hide_output_fields</a>(array(<span class="stringliteral">&#39;perm&#39;</span>));</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;    <span class="comment">// Get options passed.</span></div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;    $perm = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;filter&#39;</span>);</div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;    $roles = array();</div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;</div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;    <span class="comment">// Get all roles - if $perm is empty user_roles retrieves all roles.</span></div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;    $roles = user_roles(FALSE, $perm);</div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;    <span class="keywordflow">if</span> (empty($roles)) {</div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_NO_ROLES&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;No roles found.&quot;</span>));</div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;    }</div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;    <span class="keywordflow">foreach</span> ($roles as $rid =&gt; $value) {</div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;      $role = drush_role_get_class($rid);</div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;      $result[$role-&gt;name] = array(</div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;        <span class="stringliteral">&#39;rid&#39;</span> =&gt; $rid,</div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;        <span class="stringliteral">&#39;label&#39;</span> =&gt; $role-&gt;name,</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;      );</div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;    }</div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;  }</div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;    <a class="code" href="outputformat_8drush_8inc.html#aa114eb117d61d2a796e638caf91f92d6">drush_hide_output_fields</a>(array(<span class="stringliteral">&#39;rid&#39;</span>, <span class="stringliteral">&#39;label&#39;</span>));</div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;    $role = drush_role_get_class($rid);</div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;    <span class="keywordflow">if</span> (!$role) {</div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;      <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;    }</div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;    $perms = $role-&gt;getPerms();</div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;    <span class="keywordflow">foreach</span> ($perms as $permission) {</div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;      $result[$permission] = array(</div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;        <span class="stringliteral">&#39;perm&#39;</span> =&gt; $permission);</div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;    }</div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;  }</div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;  <span class="keywordflow">return</span> $result;</div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 8 2014 09:04:53 for Drush by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>