Drush: Drush\Psysh\DrushHelpCommand Class Reference

Public Member Functions

 setCommand (Command $command)

Public Attributes

const PSYSH_CATEGORY = 'PsySH commands'

Protected Member Functions

 configure ()
 execute (InputInterface $input, OutputInterface $output)

Protected Attributes

 $command

Detailed Description

Help command.

Lists available commands, and gives command-specific help when asked nicely.

This replaces the PsySH help command to list commands by category.

Definition at line 24 of file DrushHelpCommand.php.

Member Function Documentation

Drush\Psysh\DrushHelpCommand::configure ( )
protected

{}

Definition at line 41 of file DrushHelpCommand.php.

Drush\Psysh\DrushHelpCommand::execute ( InputInterface  $input,
OutputInterface  $output 
)
protected

{}

Definition at line 63 of file DrushHelpCommand.php.

References Drush\Psysh\DrushHelpCommand\PSYSH_CATEGORY.

Drush\Psysh\DrushHelpCommand::setCommand ( Command  $command)

Helper for setting a subcommand to retrieve help for.

Parameters
\Symfony\Component\Console\Command\Command$command

Definition at line 56 of file DrushHelpCommand.php.

Member Data Documentation

const Drush\Psysh\DrushHelpCommand::PSYSH_CATEGORY = 'PsySH commands'

Label for PsySH commands.

Definition at line 29 of file DrushHelpCommand.php.

Referenced by Drush\Psysh\DrushHelpCommand\execute().


The documentation for this class was generated from the following file:

File

doxygen/html/classDrush_1_1Psysh_1_1DrushHelpCommand.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: Drush\Psysh\DrushHelpCommand Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><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="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#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"><b>Drush</b></li><li class="navelem"><b>Psysh</b></li><li class="navelem"><a class="el" href="classDrush_1_1Psysh_1_1DrushHelpCommand.html">DrushHelpCommand</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classDrush_1_1Psysh_1_1DrushHelpCommand-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Drush\Psysh\DrushHelpCommand Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aae0e7d2767da94656e3df4a52a034f79"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDrush_1_1Psysh_1_1DrushHelpCommand.html#aae0e7d2767da94656e3df4a52a034f79">setCommand</a> (Command $command)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a993afb9afcaeb8cf5b7be25d00c9882b"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDrush_1_1Psysh_1_1DrushHelpCommand.html#a993afb9afcaeb8cf5b7be25d00c9882b">PSYSH_CATEGORY</a> = 'PsySH commands'</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aaf2e4f2a0a610a435b8ac0501a115b95"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDrush_1_1Psysh_1_1DrushHelpCommand.html#aaf2e4f2a0a610a435b8ac0501a115b95">configure</a> ()</td></tr>
<tr class="memitem:a90cc18aaf09b8c6b57418012dbe1468e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDrush_1_1Psysh_1_1DrushHelpCommand.html#a90cc18aaf09b8c6b57418012dbe1468e">execute</a> (InputInterface $input, OutputInterface $output)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ac966ea44f613ff22d6e6d528d7ea0ea8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac966ea44f613ff22d6e6d528d7ea0ea8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>$command</b></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Help command.</p>
<p>Lists available commands, and gives command-specific help when asked nicely.</p>
<p>This replaces the PsySH help command to list commands by category. </p>

<p>Definition at line <a class="el" href="DrushHelpCommand_8php_source.html#l00024">24</a> of file <a class="el" href="DrushHelpCommand_8php_source.html">DrushHelpCommand.php</a>.</p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="aaf2e4f2a0a610a435b8ac0501a115b95"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Psysh\DrushHelpCommand::configure </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>{} </p>

<p>Definition at line <a class="el" href="DrushHelpCommand_8php_source.html#l00041">41</a> of file <a class="el" href="DrushHelpCommand_8php_source.html">DrushHelpCommand.php</a>.</p>

</div>
</div>
<a class="anchor" id="a90cc18aaf09b8c6b57418012dbe1468e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Psysh\DrushHelpCommand::execute </td>
          <td>(</td>
          <td class="paramtype">InputInterface&#160;</td>
          <td class="paramname"><em>$input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">OutputInterface&#160;</td>
          <td class="paramname"><em>$output</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>{} </p>

<p>Definition at line <a class="el" href="DrushHelpCommand_8php_source.html#l00063">63</a> of file <a class="el" href="DrushHelpCommand_8php_source.html">DrushHelpCommand.php</a>.</p>

<p>References <a class="el" href="DrushHelpCommand_8php_source.html#l00029">Drush\Psysh\DrushHelpCommand\PSYSH_CATEGORY</a>.</p>

</div>
</div>
<a class="anchor" id="aae0e7d2767da94656e3df4a52a034f79"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Psysh\DrushHelpCommand::setCommand </td>
          <td>(</td>
          <td class="paramtype">Command&#160;</td>
          <td class="paramname"><em>$command</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Helper for setting a subcommand to retrieve help for.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">\Symfony\Component\Console\Command\Command</td><td class="paramname">$command</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="DrushHelpCommand_8php_source.html#l00056">56</a> of file <a class="el" href="DrushHelpCommand_8php_source.html">DrushHelpCommand.php</a>.</p>

</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a993afb9afcaeb8cf5b7be25d00c9882b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const Drush\Psysh\DrushHelpCommand::PSYSH_CATEGORY = 'PsySH commands'</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Label for PsySH commands. </p>

<p>Definition at line <a class="el" href="DrushHelpCommand_8php_source.html#l00029">29</a> of file <a class="el" href="DrushHelpCommand_8php_source.html">DrushHelpCommand.php</a>.</p>

<p>Referenced by <a class="el" href="DrushHelpCommand_8php_source.html#l00063">Drush\Psysh\DrushHelpCommand\execute()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>lib/Drush/Psysh/<a class="el" href="DrushHelpCommand_8php_source.html">DrushHelpCommand.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 2 2016 07:30:16 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>