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

  1. 7.x doxygen/html/help_8drush_8inc_source.html
  2. master doxygen/html/help_8drush_8inc_source.html
1 <?php
2 
3 /**
4  * Implementation of hook_drush_help().
5  *
6  * This function is called whenever a drush user calls
7  * 'drush help <name-of-your-command>'
8  *
9  * @param
10  * A string with the help section (prepend with 'drush:')
11  *
12  * @return
13  * A string with the help text for your command.
14  */
15 function help_drush_help($section) {
16  switch ($section) {
17  case 'drush:help':
18  return dt("Drush provides an extensive help system that describes both drush commands and topics of general interest. Use `drush help --filter` to present a list of command categories to view, and `drush topic` for a list of topics that go more in-depth on how to use and extend drush.");
19  }
20 }
21 
22 /**
23  * Implementation of hook_drush_command().
24  *
25  * In this hook, you specify which commands your
26  * drush module makes available, what it does and
27  * description.
28  *
29  * Notice how this structure closely resembles how
30  * you define menu hooks.
31  *
32  * @return
33  * An associative array describing your command(s).
34  */
35 function help_drush_command() {
36  $items = array();
37 
38  $items['help'] = array(
39  'description' => 'Print this help message. See `drush help help` for more options.',
40  'bootstrap' => DRUSH_BOOTSTRAP_NONE,
41  'allow-additional-options' => array('helpsingle'),
42  'options' => array(
43  'sort' => 'Sort commands in alphabetical order. Drush waits for full bootstrap before printing any commands when this option is used.',
44  'filter' => array(
45  'description' => 'Restrict command list to those commands defined in the specified file. Omit value to choose from a list of names.',
46  'example-value' => 'category',
47  'value' => 'optional',
48  ),
49  ),
50  'arguments' => array(
51  'command' => 'A command name, or command alias.',
52  ),
53  'examples' => array(
54  'drush' => 'List all commands.',
55  'drush --filter=devel_generate' => 'Show only commands defined in devel_generate.drush.inc',
56  'drush help pm-download' => 'Show help for one command.',
57  'drush help dl' => 'Show help for one command using an alias.',
58  'drush help --format=html' => 'Show an HTML page detailing all available commands.',
59  'drush help --format=json' => 'All available comamnds, in a machine parseable format.',
60  ),
61  // Use output format system for all formats except the default presentation.
62  'outputformat' => array(
63  'default' => 'table',
64  'field-labels' => array('name' => 'Name', 'description' => 'Description'),
65  'output-data-type' => 'format-table',
66  ),
67  'topics' => array('docs-readme'),
68  );
69  return $items;
70 }
71 
72 
73 /**
74  * Command argument complete callback.
75  *
76  * For now, this can't move to helpsingle since help command is the entry point for both.
77  *
78  * @return
79  * Array of available command names.
80  */
81 function core_help_complete() {
82  return array('values' => array_keys(drush_get_commands()));
83 }
84 
85 /**
86  * Command callback for help command. This is the default command, when none
87  * other has been specified.
88  */
89 function drush_core_help($name = '') {
90  $format = drush_get_option('format', 'table');
91  if ($name) {
92  // helpsingle command builds output when a command is specified.
93  $options = drush_redispatch_get_options();
94  if ($name != 'help') {
95  unset($options['help']);
96  }
97  $return = drush_invoke_process('@self' ,'helpsingle', func_get_args(), $options);
98  drush_backend_set_result($return['object']);
99  return;
100  }
101 
103  drush_get_commands(true);
104  $implemented = drush_get_commands();
105  ksort($implemented);
106  $command_categories = drush_commands_categorize($implemented);
107  if ($format != 'table') {
108  return $command_categories;
109  }
110  else {
111  $visible = drush_help_visible($command_categories);
112 
113  // If the user specified --filter w/out a value, then
114  // present a choice list of help categories.
115  if (drush_get_option('filter', FALSE) === TRUE) {
116  $help_categories = array();
117  foreach ($command_categories as $key => $info) {
118  $description = $info['title'];
119  if (array_key_exists('summary', $info)) {
120  $description .= ": " . $info['summary'];
121  }
122  $help_categories[$key] = $description;
123  }
124  $result = drush_choice($help_categories, 'Select a help category:');
125  if (!$result) {
126  return drush_user_abort();
127  }
128  drush_set_option('filter', $result);
129  }
130  // Filter out categories that the user does not want to see
131  $filter_category = drush_get_option('filter');
132  if (!empty($filter_category) && ($filter_category !== TRUE)) {
133  if (!array_key_exists($filter_category, $command_categories)) {
134  return drush_set_error('DRUSH_NO_CATEGORY', dt("The specified command category !filter does not exist.", array('!filter' => $filter_category)));
135  }
136  $command_categories = array($filter_category => $command_categories[$filter_category]);
137  }
138 
139  // Make a fake command section to hold the global options, then print it.
140  $global_options_help = drush_global_options_command(TRUE);
141  if (!drush_get_option('filter')) {
142  drush_print_help($global_options_help);
143  }
144  drush_help_listing_print($command_categories);
145  drush_backend_set_result($command_categories);
146  return;
147  }
148 }
149 
150 // Uncategorize the list of commands. Hiddens have been removed and
151 // filtering performed.
152 function drush_help_visible($command_categories) {
153  $all = array();
154  foreach ($command_categories as $category => $info) {
155  $all = array_merge($all, $info['commands']);
156  }
157  return $all;
158 }
159 
160 /**
161  * Print CLI table listing all commands.
162  */
163 function drush_help_listing_print($command_categories) {
164  $all_commands = array();
165  foreach ($command_categories as $key => $info) {
166  // Get the commands in this category.
167  $commands = $info['commands'];
168 
169  // Build rows for drush_print_table().
170  $rows = array();
171  foreach($commands as $cmd => $command) {
172  $name = $command['aliases'] ? $cmd . ' (' . implode(', ', $command['aliases']) . ')': $cmd;
173  $rows[$cmd] = array('name' => $name, 'description' => $command['description']);
174  }
175  drush_print($info['title'] . ": (" . $key . ")");
176  drush_print_table($rows, FALSE, array('name' => 20));
177  }
178 }
179 
180 /**
181  * Build a fake command for the purposes of showing examples and options.
182  */
183 function drush_global_options_command($brief = FALSE) {
184  $global_options_help = array(
185  'description' => 'Execute a drush command. Run `drush help [command]` to view command-specific help. Run `drush topic` to read even more documentation.',
186  'sections' => array(
187  'options' => 'Global options (see `drush topic core-global-options` for the full list)',
188  ),
189  'options' => drush_get_global_options($brief),
190  'examples' => array(
191  'drush dl cck zen' => 'Download CCK module and Zen theme.',
192  'drush --uri=http://example.com status' => 'Show status command for the example.com multi-site.',
193  ),
194  '#brief' => TRUE,
195  );
196  $global_options_help += drush_command_defaults('global-options', 'global_options', __FILE__);
197  drush_command_invoke_all_ref('drush_help_alter', $global_options_help);
198  ksort($global_options_help['options']);
199 
200  return $global_options_help;
201 }

File

doxygen/html/help_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/help.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="namespaces.html"><span>Namespaces</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><a href="examples.html"><span>Examples</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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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">help.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;<span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Implementation of hook_drush_help().</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"> * This function is called whenever a drush user calls</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * &#39;drush help &lt;name-of-your-command&gt;&#39;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * @param</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *   A string with the help section (prepend with &#39;drush:&#39;)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *   A string with the help text for your command.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keyword">function</span> help_drush_help($section) {</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;  <span class="keywordflow">switch</span> ($section) {</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    <span class="keywordflow">case</span> <span class="stringliteral">&#39;drush:help&#39;</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Drush provides an extensive help system that describes both drush commands and topics of general interest.  Use `drush help --filter` to present a list of command categories to view, and `drush topic` for a list of topics that go more in-depth on how to use and extend drush.&quot;</span>);</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;  }</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;}</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * Implementation of hook_drush_command().</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * In this hook, you specify which commands your</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * drush module makes available, what it does and</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * description.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * Notice how this structure closely resembles how</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * you define menu hooks.</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"> * @return</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> *   An associative array describing your command(s).</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">function</span> help_drush_command() {</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;  $items = array();</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  $items[<span class="stringliteral">&#39;help&#39;</span>] = array(</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Print this help message. See `drush help help` for more options.&#39;</span>,</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="stringliteral">&#39;bootstrap&#39;</span> =&gt; DRUSH_BOOTSTRAP_NONE,</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="stringliteral">&#39;allow-additional-options&#39;</span> =&gt; array(<span class="stringliteral">&#39;helpsingle&#39;</span>),</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="stringliteral">&#39;options&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;      <span class="stringliteral">&#39;sort&#39;</span> =&gt; <span class="stringliteral">&#39;Sort commands in alphabetical order. Drush waits for full bootstrap before printing any commands when this option is used.&#39;</span>,</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;      <span class="stringliteral">&#39;filter&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;        <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Restrict command list to those commands defined in the specified file. Omit value to choose from a list of names.&#39;</span>,</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        <span class="stringliteral">&#39;example-value&#39;</span> =&gt; <span class="stringliteral">&#39;category&#39;</span>,</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        <span class="stringliteral">&#39;value&#39;</span> =&gt; <span class="stringliteral">&#39;optional&#39;</span>,</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;      ),</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    ),</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="stringliteral">&#39;arguments&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;      <span class="stringliteral">&#39;command&#39;</span> =&gt; <span class="stringliteral">&#39;A command name, or command alias.&#39;</span>,</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    ),</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;      <span class="stringliteral">&#39;drush&#39;</span> =&gt; <span class="stringliteral">&#39;List all commands.&#39;</span>,</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;      <span class="stringliteral">&#39;drush --filter=devel_generate&#39;</span> =&gt; <span class="stringliteral">&#39;Show only commands defined in devel_generate.drush.inc&#39;</span>,</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;      <span class="stringliteral">&#39;drush help pm-download&#39;</span> =&gt; <span class="stringliteral">&#39;Show help for one command.&#39;</span>,</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;      <span class="stringliteral">&#39;drush help dl&#39;</span> =&gt; <span class="stringliteral">&#39;Show help for one command using an alias.&#39;</span>,</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;      <span class="stringliteral">&#39;drush help --format=html&#39;</span> =&gt; <span class="stringliteral">&#39;Show an HTML page detailing all available commands.&#39;</span>,</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;      <span class="stringliteral">&#39;drush help --format=json&#39;</span> =&gt; <span class="stringliteral">&#39;All available comamnds, in a machine parseable format.&#39;</span>,</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    ),</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="comment">// Use output format system for all formats except the default presentation.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="stringliteral">&#39;outputformat&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;      <span class="stringliteral">&#39;default&#39;</span> =&gt; <span class="stringliteral">&#39;table&#39;</span>,</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;      <span class="stringliteral">&#39;field-labels&#39;</span> =&gt; array(<span class="stringliteral">&#39;name&#39;</span> =&gt; <span class="stringliteral">&#39;Name&#39;</span>, <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Description&#39;</span>),</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</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="l00066"></a><span class="lineno">   66</span>&#160;    ),</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="stringliteral">&#39;topics&#39;</span> =&gt; array(<span class="stringliteral">&#39;docs-readme&#39;</span>),</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  );</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="keywordflow">return</span> $items;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;}</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="comment"></span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> * Command argument complete callback.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * For now, this can&#39;t move to helpsingle since help command is the entry point for both.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> *   Array of available command names.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="keyword">function</span> core_help_complete() {</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  <span class="keywordflow">return</span> array(<span class="stringliteral">&#39;values&#39;</span> =&gt; array_keys(<a class="code" href="command_8inc.html#af0c377881e5c9c772f0cad80ea016452">drush_get_commands</a>()));</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="comment"></span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * Command callback for help command. This is the default command, when none</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> * other has been specified.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="keyword">function</span> drush_core_help($name = <span class="stringliteral">&#39;&#39;</span>) {</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;  $format = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;format&#39;</span>, <span class="stringliteral">&#39;table&#39;</span>);</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  <span class="keywordflow">if</span> ($name) {</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="comment">// helpsingle command builds output when a command is specified.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    $options = <a class="code" href="group__dispatching.html#ga9b1a98376983ee529fc868ef4280b12d">drush_redispatch_get_options</a>();</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <span class="keywordflow">if</span> ($name != <span class="stringliteral">&#39;help&#39;</span>) {</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;      unset($options[<span class="stringliteral">&#39;help&#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;    $return = <a class="code" href="group__dispatching.html#ga125471885af052278a0874446b332cf9">drush_invoke_process</a>(<span class="stringliteral">&#39;@self&#39;</span> ,<span class="stringliteral">&#39;helpsingle&#39;</span>, func_get_args(), $options);</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    <a class="code" href="backend_8inc.html#ad8040331b08464a2a48b7ac8a00ed13c">drush_backend_set_result</a>($return[<span class="stringliteral">&#39;object&#39;</span>]);</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  }</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  </div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  drush_bootstrap_max();</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  <a class="code" href="command_8inc.html#af0c377881e5c9c772f0cad80ea016452">drush_get_commands</a>(<span class="keyword">true</span>);</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  $implemented = <a class="code" href="command_8inc.html#af0c377881e5c9c772f0cad80ea016452">drush_get_commands</a>();</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  ksort($implemented);</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;  $command_categories = <a class="code" href="command_8inc.html#a5481c5ad60bef8dd11a851fcc35770ae">drush_commands_categorize</a>($implemented);</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;  <span class="keywordflow">if</span> ($format != <span class="stringliteral">&#39;table&#39;</span>) {</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <span class="keywordflow">return</span> $command_categories;</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;  }</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    $visible = drush_help_visible($command_categories);</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    <span class="comment">// If the user specified --filter w/out a value, then</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    <span class="comment">// present a choice list of help categories.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    <span class="keywordflow">if</span> (<a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;filter&#39;</span>, FALSE) === TRUE) {</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;      $help_categories = array();</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;      <span class="keywordflow">foreach</span> ($command_categories as $key =&gt; $info) {</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;        $description = $info[<span class="stringliteral">&#39;title&#39;</span>];</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        <span class="keywordflow">if</span> (array_key_exists(<span class="stringliteral">&#39;summary&#39;</span>, $info)) {</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;          $description .= <span class="stringliteral">&quot;: &quot;</span> . $info[<span class="stringliteral">&#39;summary&#39;</span>];</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        }</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        $help_categories[$key] = $description;</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;      $result = <a class="code" href="group__userinput.html#ga7e823bcd58051b17e6e5601340f0c784">drush_choice</a>($help_categories, <span class="stringliteral">&#39;Select a help category:&#39;</span>);</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;      <span class="keywordflow">if</span> (!$result) {</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga366aaafdf8c774a58653c64a65b6d91c">drush_user_abort</a>();</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;      }</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;      <a class="code" href="context_8inc.html#aa4b55e2f6174c8b6efaa8f23a0f9e0af">drush_set_option</a>(<span class="stringliteral">&#39;filter&#39;</span>, $result);</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    }</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;    <span class="comment">// Filter out categories that the user does not want to see</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    $filter_category = <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="l00132"></a><span class="lineno">  132</span>&#160;    <span class="keywordflow">if</span> (!empty($filter_category) &amp;&amp; ($filter_category !== TRUE)) {</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;      <span class="keywordflow">if</span> (!array_key_exists($filter_category, $command_categories)) {</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</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_CATEGORY&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;The specified command category !filter does not exist.&quot;</span>, array(<span class="stringliteral">&#39;!filter&#39;</span> =&gt; $filter_category)));</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;      }</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;      $command_categories = array($filter_category =&gt; $command_categories[$filter_category]);</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;    }</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="comment">// Make a fake command section to hold the global options, then print it.</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    $global_options_help = drush_global_options_command(TRUE);</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    <span class="keywordflow">if</span> (!<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="l00142"></a><span class="lineno">  142</span>&#160;      drush_print_help($global_options_help);</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    }</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;    drush_help_listing_print($command_categories);</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;    <a class="code" href="backend_8inc.html#ad8040331b08464a2a48b7ac8a00ed13c">drush_backend_set_result</a>($command_categories);</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;    <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;  }</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;}</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment">// Uncategorize the list of commands. Hiddens have been removed and</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">// filtering performed.</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="keyword">function</span> drush_help_visible($command_categories) {</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;  $all = array();</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;  <span class="keywordflow">foreach</span> ($command_categories as $category =&gt; $info) {</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;    $all = array_merge($all,  $info[<span class="stringliteral">&#39;commands&#39;</span>]);</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;  }</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;  <span class="keywordflow">return</span> $all;</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;}</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment"> * Print CLI table listing all commands.</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="keyword">function</span> drush_help_listing_print($command_categories) {</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;  $all_commands = array();</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;  <span class="keywordflow">foreach</span> ($command_categories as $key =&gt; $info) {</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;    <span class="comment">// Get the commands in this category.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    $commands = $info[<span class="stringliteral">&#39;commands&#39;</span>];</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    <span class="comment">// Build rows for drush_print_table().</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    $rows = array();</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;    <span class="keywordflow">foreach</span>($commands as $cmd =&gt; $command) {</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;      $name = $command[<span class="stringliteral">&#39;aliases&#39;</span>] ? $cmd . <span class="stringliteral">&#39; (&#39;</span> . implode(<span class="stringliteral">&#39;, &#39;</span>, $command[<span class="stringliteral">&#39;aliases&#39;</span>]) . <span class="charliteral">&#39;)&#39;</span>: $cmd;</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;      $rows[$cmd] = array(<span class="stringliteral">&#39;name&#39;</span> =&gt; $name, <span class="stringliteral">&#39;description&#39;</span> =&gt; $command[<span class="stringliteral">&#39;description&#39;</span>]);</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    }</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;    <a class="code" href="group__outputfunctions.html#ga63acbb94925d6d2693e235e966bba740">drush_print</a>($info[<span class="stringliteral">&#39;title&#39;</span>] . <span class="stringliteral">&quot;: (&quot;</span> . $key . <span class="stringliteral">&quot;)&quot;</span>);</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    <a class="code" href="group__outputfunctions.html#ga2dfb80176f98c67097334acfa98211cd">drush_print_table</a>($rows, FALSE, array(<span class="stringliteral">&#39;name&#39;</span> =&gt; 20));</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;  }</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;}</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"> * Build a fake command for the purposes of showing examples and options.</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="keyword">function</span> drush_global_options_command($brief = FALSE) {</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;  $global_options_help = array(</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Execute a drush command. Run `drush help [command]` to view command-specific help.  Run `drush topic` to read even more documentation.&#39;</span>,</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    <span class="stringliteral">&#39;sections&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;      <span class="stringliteral">&#39;options&#39;</span> =&gt; <span class="stringliteral">&#39;Global options (see `drush topic core-global-options` for the full list)&#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;    <span class="stringliteral">&#39;options&#39;</span> =&gt; <a class="code" href="drush_8inc.html#acb0a26e79bcbdd1152d59a6916a35aae">drush_get_global_options</a>($brief),</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;      <span class="stringliteral">&#39;drush dl cck zen&#39;</span> =&gt; <span class="stringliteral">&#39;Download CCK module and Zen theme.&#39;</span>,</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;      <span class="stringliteral">&#39;drush --uri=http://example.com status&#39;</span> =&gt; <span class="stringliteral">&#39;Show status command for the example.com multi-site.&#39;</span>,</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;    ),</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;    <span class="stringliteral">&#39;#brief&#39;</span> =&gt; TRUE,</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;  );</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;  $global_options_help += drush_command_defaults(<span class="stringliteral">&#39;global-options&#39;</span>, <span class="stringliteral">&#39;global_options&#39;</span>, __FILE__);</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;  <a class="code" href="command_8inc.html#a74995cc76034e90a39baee51111b20be">drush_command_invoke_all_ref</a>(<span class="stringliteral">&#39;drush_help_alter&#39;</span>, $global_options_help);</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;  ksort($global_options_help[<span class="stringliteral">&#39;options&#39;</span>]);</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;  <span class="keywordflow">return</span> $global_options_help;</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 2 2016 07:28: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>