Drush: Drush\Queue\QueueBase Class Reference

Inheritance diagram for Drush\Queue\QueueBase:
Collaboration diagram for Drush\Queue\QueueBase:

Public Member Functions

 listQueues ()
 getInfo ($name)
- Public Member Functions inherited from Drush\Queue\QueueInterface
 getQueues ()
 run ($name, $time_limit=0)
 getQueue ($name)

Static Protected Attributes

static $queues

Detailed Description

Definition at line 5 of file QueueBase.php.

Member Function Documentation

Drush\Queue\QueueBase::getInfo (   $name)

{Returns a given queue definition.

Parameters
string$nameThe name of the queue to run.
}

Implements Drush\Queue\QueueInterface.

Definition at line 33 of file QueueBase.php.

References dt(), and Drush\Queue\QueueInterface\getQueues().

Referenced by Drush\Queue\Queue7\run().

Here is the call graph for this function:

Here is the caller graph for this function:

Drush\Queue\QueueBase::listQueues ( )

Lists all available queues.

Definition at line 17 of file QueueBase.php.

References Drush\Queue\QueueInterface\getQueue(), and Drush\Queue\QueueInterface\getQueues().

Here is the call graph for this function:


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

File

doxygen/html/classDrush_1_1Queue_1_1QueueBase.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\Queue\QueueBase 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>Queue</b></li><li class="navelem"><a class="el" href="classDrush_1_1Queue_1_1QueueBase.html">QueueBase</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="classDrush_1_1Queue_1_1QueueBase-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Drush\Queue\QueueBase Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Drush\Queue\QueueBase:</div>
<div class="dyncontent">
<div class="center"><img src="classDrush_1_1Queue_1_1QueueBase__inherit__graph.png" border="0" usemap="#Drush_0CQueue_0CQueueBase_inherit__map" alt="Inheritance graph"/></div>
<map name="Drush_0CQueue_0CQueueBase_inherit__map" id="Drush_0CQueue_0CQueueBase_inherit__map">
<area shape="rect" id="node5" href="classDrush_1_1Queue_1_1Queue7.html" title="Drush\\Queue\\Queue7" alt="" coords="5,160,152,189"/><area shape="rect" id="node7" href="classDrush_1_1Queue_1_1Queue8.html" title="Drush\\Queue\\Queue8" alt="" coords="176,160,323,189"/><area shape="rect" id="node2" href="interfaceDrush_1_1Queue_1_1QueueInterface.html" title="Drush\\Queue\\QueueInterface" alt="" coords="68,5,260,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Drush\Queue\QueueBase:</div>
<div class="dyncontent">
<div class="center"><img src="classDrush_1_1Queue_1_1QueueBase__coll__graph.png" border="0" usemap="#Drush_0CQueue_0CQueueBase_coll__map" alt="Collaboration graph"/></div>
<map name="Drush_0CQueue_0CQueueBase_coll__map" id="Drush_0CQueue_0CQueueBase_coll__map">
<area shape="rect" id="node2" href="interfaceDrush_1_1Queue_1_1QueueInterface.html" title="Drush\\Queue\\QueueInterface" alt="" coords="5,5,197,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adac1fcecf8ecc53cdbf291819aacb921"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDrush_1_1Queue_1_1QueueBase.html#adac1fcecf8ecc53cdbf291819aacb921">listQueues</a> ()</td></tr>
<tr class="memitem:ac7a9bceaefa8864c29cc6a403c524fe9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDrush_1_1Queue_1_1QueueBase.html#ac7a9bceaefa8864c29cc6a403c524fe9">getInfo</a> ($name)</td></tr>
<tr class="inherit_header pub_methods_interfaceDrush_1_1Queue_1_1QueueInterface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceDrush_1_1Queue_1_1QueueInterface')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html">Drush\Queue\QueueInterface</a></td></tr>
<tr class="memitem:a4e69111579de6c21475468b17c438efb inherit pub_methods_interfaceDrush_1_1Queue_1_1QueueInterface"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a4e69111579de6c21475468b17c438efb">getQueues</a> ()</td></tr>
<tr class="memitem:a1e369ebf8640151ae6a605c69a025265 inherit pub_methods_interfaceDrush_1_1Queue_1_1QueueInterface"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a1e369ebf8640151ae6a605c69a025265">run</a> ($name, $time_limit=0)</td></tr>
<tr class="memitem:ad564c199335ca8e2acd0238fb739f801 inherit pub_methods_interfaceDrush_1_1Queue_1_1QueueInterface"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#ad564c199335ca8e2acd0238fb739f801">getQueue</a> ($name)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a430ae0caae583c8c890ef1a3df7123d2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a430ae0caae583c8c890ef1a3df7123d2"></a>
static&#160;</td><td class="memItemRight" valign="bottom"><b>$queues</b></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="QueueBase_8php_source.html#l00005">5</a> of file <a class="el" href="QueueBase_8php_source.html">QueueBase.php</a>.</p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="ac7a9bceaefa8864c29cc6a403c524fe9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Queue\QueueBase::getInfo </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>{Returns a given queue definition.<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">string</td><td class="paramname">$name</td><td>The name of the queue to run.</td></tr>
  </table>
  </dd>
</dl>
} </p>

<p>Implements <a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a240f44a88064a7b96fe2cb66f6a6ffcb">Drush\Queue\QueueInterface</a>.</p>

<p>Definition at line <a class="el" href="QueueBase_8php_source.html#l00033">33</a> of file <a class="el" href="QueueBase_8php_source.html">QueueBase.php</a>.</p>

<p>References <a class="el" href="output_8inc_source.html#l00149">dt()</a>, and <a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a4e69111579de6c21475468b17c438efb">Drush\Queue\QueueInterface\getQueues()</a>.</p>

<p>Referenced by <a class="el" href="Queue7_8php_source.html#l00042">Drush\Queue\Queue7\run()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_cgraph.png" border="0" usemap="#classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_cgraph" alt=""/></div>
<map name="classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_cgraph" id="classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_cgraph">
<area shape="rect" id="node3" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="301,63,339,92"/><area shape="rect" id="node19" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a4e69111579de6c21475468b17c438efb" title="Drush\\Queue\\QueueInterface\l\\getQueues" alt="" coords="224,115,416,162"/><area shape="rect" id="node5" href="drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="467,23,600,70"/><area shape="rect" id="node17" href="group__outputfunctions.html#ga2391425402626377e6464f1f649f8c65" title="find_legacy_dt_args" alt="" coords="464,93,603,123"/><area shape="rect" id="node7" href="drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="652,32,796,61"/><area shape="rect" id="node9" href="classDrush.html#a104f09419bc8a46c4bf205b49268b3a4" title="Drush\\bootstrapManager" alt="" coords="845,5,1011,35"/><area shape="rect" id="node15" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="864,59,992,88"/><area shape="rect" id="node11" href="classDrush.html#a83560a0aab97e348848b3615f152af54" title="Drush\\service" alt="" coords="1060,5,1161,35"/><area shape="rect" id="node13" href="classDrush.html#abce7035069a9f7517f908b82bdd4dae0" title="Drush\\getContainer" alt="" coords="1212,5,1345,35"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_icgraph.png" border="0" usemap="#classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_icgraph" alt=""/></div>
<map name="classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_icgraph" id="classDrush_1_1Queue_1_1QueueBase_ac7a9bceaefa8864c29cc6a403c524fe9_icgraph">
<area shape="rect" id="node3" href="classDrush_1_1Queue_1_1Queue7.html#ac02b12a233a3570608360b451052fd73" title="Drush\\Queue\\Queue7\\run" alt="" coords="224,13,395,43"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="adac1fcecf8ecc53cdbf291819aacb921"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Queue\QueueBase::listQueues </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Lists all available queues. </p>

<p>Definition at line <a class="el" href="QueueBase_8php_source.html#l00017">17</a> of file <a class="el" href="QueueBase_8php_source.html">QueueBase.php</a>.</p>

<p>References <a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#ad564c199335ca8e2acd0238fb739f801">Drush\Queue\QueueInterface\getQueue()</a>, and <a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a4e69111579de6c21475468b17c438efb">Drush\Queue\QueueInterface\getQueues()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classDrush_1_1Queue_1_1QueueBase_adac1fcecf8ecc53cdbf291819aacb921_cgraph.png" border="0" usemap="#classDrush_1_1Queue_1_1QueueBase_adac1fcecf8ecc53cdbf291819aacb921_cgraph" alt=""/></div>
<map name="classDrush_1_1Queue_1_1QueueBase_adac1fcecf8ecc53cdbf291819aacb921_cgraph" id="classDrush_1_1Queue_1_1QueueBase_adac1fcecf8ecc53cdbf291819aacb921_cgraph">
<area shape="rect" id="node3" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#ad564c199335ca8e2acd0238fb739f801" title="Drush\\Queue\\QueueInterface\l\\getQueue" alt="" coords="224,5,416,51"/><area shape="rect" id="node5" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a4e69111579de6c21475468b17c438efb" title="Drush\\Queue\\QueueInterface\l\\getQueues" alt="" coords="224,74,416,121"/></map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>lib/Drush/Queue/<a class="el" href="QueueBase_8php_source.html">QueueBase.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>