Drush: commands/core/state.drush.inc File Reference

  1. 7.x doxygen/html/state_8drush_8inc.html
  2. master doxygen/html/state_8drush_8inc.html
state.drush.inc File Reference

Go to the source code of this file.

Functions

 state_drush_help ($section)
 state_drush_command ()
 drush_state_get ($key=NULL)
 drush_state_set ($key=NULL, $value=NULL)
 drush_state_delete ($key=NULL)

Detailed Description

Provides State commands.

Definition in file state.drush.inc.

Function Documentation

drush_state_delete (   $key = NULL)

State delete command callback.

$key The state key.

Definition at line 130 of file state.drush.inc.

drush_state_get (   $key = NULL)

State get command callback.

$key The state key.

Definition at line 90 of file state.drush.inc.

drush_state_set (   $key = NULL,
  $value = NULL 
)

State set command callback.

Parameters
$keyThe config key.
$valueThe data to save to state.

Definition at line 102 of file state.drush.inc.

References drush_get_option(), drush_set_error(), and dt().

Here is the call graph for this function:

state_drush_command ( )

Implementation of hook_drush_command().

Definition at line 23 of file state.drush.inc.

state_drush_help (   $section)

Implementation of hook_drush_help().

Definition at line 11 of file state.drush.inc.

References dt().

Here is the call graph for this function:

File

doxygen/html/state_8drush_8inc.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/state.drush.inc File 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><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="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">state.drush.inc File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a href="state_8drush_8inc_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a75b9c90b636c6e0afee136cf5989ea84"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="state_8drush_8inc.html#a75b9c90b636c6e0afee136cf5989ea84">state_drush_help</a> ($section)</td></tr>
<tr class="memitem:a8d63b18cb28e0988fd49bb8b51338de6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="state_8drush_8inc.html#a8d63b18cb28e0988fd49bb8b51338de6">state_drush_command</a> ()</td></tr>
<tr class="memitem:a23e392fb6881072bf11efc642b7569ad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="state_8drush_8inc.html#a23e392fb6881072bf11efc642b7569ad">drush_state_get</a> ($key=NULL)</td></tr>
<tr class="memitem:a375576b7785771c6f58d7ccb7dafe432"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="state_8drush_8inc.html#a375576b7785771c6f58d7ccb7dafe432">drush_state_set</a> ($key=NULL, $value=NULL)</td></tr>
<tr class="memitem:ab23cf352931f04d8c48e5e5d246b0c50"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="state_8drush_8inc.html#ab23cf352931f04d8c48e5e5d246b0c50">drush_state_delete</a> ($key=NULL)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Provides State commands. </p>

<p>Definition in file <a class="el" href="state_8drush_8inc_source.html">state.drush.inc</a>.</p>
</div><h2>Function Documentation</h2>
<a class="anchor" id="ab23cf352931f04d8c48e5e5d246b0c50"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_state_delete </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$key</em> = <code>NULL</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>State delete command callback.</p>
<p>$key The state key. </p>

<p>Definition at line <a class="el" href="state_8drush_8inc_source.html#l00130">130</a> of file <a class="el" href="state_8drush_8inc_source.html">state.drush.inc</a>.</p>

</div>
</div>
<a class="anchor" id="a23e392fb6881072bf11efc642b7569ad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_state_get </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$key</em> = <code>NULL</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>State get command callback.</p>
<p>$key The state key. </p>

<p>Definition at line <a class="el" href="state_8drush_8inc_source.html#l00090">90</a> of file <a class="el" href="state_8drush_8inc_source.html">state.drush.inc</a>.</p>

</div>
</div>
<a class="anchor" id="a375576b7785771c6f58d7ccb7dafe432"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_state_set </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$key</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$value</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>State set command callback.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">$key</td><td>The config key. </td></tr>
    <tr><td class="paramname">$value</td><td>The data to save to state. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="state_8drush_8inc_source.html#l00102">102</a> of file <a class="el" href="state_8drush_8inc_source.html">state.drush.inc</a>.</p>

<p>References <a class="el" href="context_8inc_source.html#l00405">drush_get_option()</a>, <a class="el" href="drush_8inc_source.html#l01525">drush_set_error()</a>, and <a class="el" href="output_8inc_source.html#l00149">dt()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="state_8drush_8inc_a375576b7785771c6f58d7ccb7dafe432_cgraph.png" border="0" usemap="#state_8drush_8inc_a375576b7785771c6f58d7ccb7dafe432_cgraph" alt=""/></div>
<map name="state_8drush_8inc_a375576b7785771c6f58d7ccb7dafe432_cgraph" id="state_8drush_8inc_a375576b7785771c6f58d7ccb7dafe432_cgraph">
<area shape="rect" id="node3" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8" title="drush_get_option" alt="" coords="169,85,289,115"/><area shape="rect" id="node11" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4" title="drush_set_error" alt="" coords="173,240,285,269"/><area shape="rect" id="node31" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="211,379,248,408"/><area shape="rect" id="node5" href="context_8inc.html#aee5781894bf828bfa508d9052553f809" title="_drush_get_option" alt="" coords="367,5,495,35"/><area shape="rect" id="node7" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="980,217,1108,247"/><area shape="rect" id="node9" href="context_8inc.html#a9f6272c1a68141ce873c07aae3a316ac" title="drush_context_names" alt="" coords="356,59,505,88"/><area shape="rect" id="node14" href="command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9" title="drush_command_invoke_all" alt="" coords="340,213,521,243"/><area shape="rect" id="node16" href="backend_8inc.html#a38490210d77373f3d8492caf4e9a3190" title="drush_backend_packet" alt="" coords="771,217,925,247"/><area shape="rect" id="node19" href="group__logging.html#ga47324b65808524558a488916b150dd51" title="drush_log" alt="" coords="392,317,469,347"/><area shape="rect" id="node21" href="group__logging.html#ga10110f5007bd6fd1b7915e9dece4774f" title="_drush_log" alt="" coords="601,317,687,347"/><area shape="rect" id="node24" href="classDrush.html#aeda0f4644c7f586f873055d39dd755a5" title="Drush\\logger" alt="" coords="800,321,896,351"/><area shape="rect" id="node26" href="classDrush.html#a83560a0aab97e348848b3615f152af54" title="Drush\\service" alt="" coords="993,373,1095,403"/><area shape="rect" id="node28" href="classDrush.html#abce7035069a9f7517f908b82bdd4dae0" title="Drush\\getContainer" alt="" coords="1159,373,1292,403"/><area shape="rect" id="node33" href="drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="364,370,497,417"/><area shape="rect" id="node41" href="group__outputfunctions.html#ga2391425402626377e6464f1f649f8c65" title="find_legacy_dt_args" alt="" coords="361,440,500,469"/><area shape="rect" id="node35" href="drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="572,379,716,408"/><area shape="rect" id="node38" href="classDrush.html#a104f09419bc8a46c4bf205b49268b3a4" title="Drush\\bootstrapManager" alt="" coords="765,425,931,455"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a8d63b18cb28e0988fd49bb8b51338de6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">state_drush_command </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Implementation of <a class="el" href="drush_8api_8php.html#ad8372d595205e79e81d7700f4f59b31c">hook_drush_command()</a>. </p>

<p>Definition at line <a class="el" href="state_8drush_8inc_source.html#l00023">23</a> of file <a class="el" href="state_8drush_8inc_source.html">state.drush.inc</a>.</p>

</div>
</div>
<a class="anchor" id="a75b9c90b636c6e0afee136cf5989ea84"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">state_drush_help </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$section</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Implementation of hook_drush_help(). </p>

<p>Definition at line <a class="el" href="state_8drush_8inc_source.html#l00011">11</a> of file <a class="el" href="state_8drush_8inc_source.html">state.drush.inc</a>.</p>

<p>References <a class="el" href="output_8inc_source.html#l00149">dt()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="state_8drush_8inc_a75b9c90b636c6e0afee136cf5989ea84_cgraph.png" border="0" usemap="#state_8drush_8inc_a75b9c90b636c6e0afee136cf5989ea84_cgraph" alt=""/></div>
<map name="state_8drush_8inc_a75b9c90b636c6e0afee136cf5989ea84_cgraph" id="state_8drush_8inc_a75b9c90b636c6e0afee136cf5989ea84_cgraph">
<area shape="rect" id="node3" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="177,63,215,92"/><area shape="rect" id="node5" href="drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="267,23,400,70"/><area shape="rect" id="node17" href="group__outputfunctions.html#ga2391425402626377e6464f1f649f8c65" title="find_legacy_dt_args" alt="" coords="264,93,403,123"/><area shape="rect" id="node7" href="drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="452,32,596,61"/><area shape="rect" id="node9" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="664,5,792,35"/><area shape="rect" id="node11" href="classDrush.html#a104f09419bc8a46c4bf205b49268b3a4" title="Drush\\bootstrapManager" alt="" coords="645,59,811,88"/><area shape="rect" id="node13" href="classDrush.html#a83560a0aab97e348848b3615f152af54" title="Drush\\service" alt="" coords="860,59,961,88"/><area shape="rect" id="node15" href="classDrush.html#abce7035069a9f7517f908b82bdd4dae0" title="Drush\\getContainer" alt="" coords="1012,59,1145,88"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 14 2016 07:27:45 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>