Drush: Drush\Queue\QueueInterface Interface Reference

Inheritance diagram for Drush\Queue\QueueInterface:

Public Member Functions

 getQueues ()
 run ($name, $time_limit=0)
 getQueue ($name)
 getInfo ($name)

Detailed Description

Defines an interface for interacting with queues.

Definition at line 8 of file QueueInterface.php.

Member Function Documentation

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

Returns a given queue definition.

Parameters
string$nameThe name of the queue to run.

Implemented in Drush\Queue\QueueBase.

Drush\Queue\QueueInterface::getQueue (   $name)

Returns a given queue definition.

Parameters
string$nameThe name of the queue to run.

Implemented in Drush\Queue\Queue8, and Drush\Queue\Queue7.

Referenced by Drush\Queue\QueueBase\listQueues().

Here is the caller graph for this function:

Returns all queues.

Implemented in Drush\Queue\Queue8, and Drush\Queue\Queue7.

Referenced by Drush\Queue\QueueBase\getInfo(), and Drush\Queue\QueueBase\listQueues().

Here is the caller graph for this function:

Drush\Queue\QueueInterface::run (   $name,
  $time_limit = 0 
)

Runs a given queue.

Parameters
string$nameThe name of the queue to run.
int$time_limitThe maximum number of seconds that the queue can run. By default the queue will be run as long as possible.
Returns
int The number of items successfully processed from the queue.

Implemented in Drush\Queue\Queue8, and Drush\Queue\Queue7.


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

File

doxygen/html/interfaceDrush_1_1Queue_1_1QueueInterface.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\QueueInterface Interface 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="interfaceDrush_1_1Queue_1_1QueueInterface.html">QueueInterface</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interfaceDrush_1_1Queue_1_1QueueInterface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Drush\Queue\QueueInterface Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Drush\Queue\QueueInterface:</div>
<div class="dyncontent">
<div class="center"><img src="interfaceDrush_1_1Queue_1_1QueueInterface__inherit__graph.png" border="0" usemap="#Drush_0CQueue_0CQueueInterface_inherit__map" alt="Inheritance graph"/></div>
<map name="Drush_0CQueue_0CQueueInterface_inherit__map" id="Drush_0CQueue_0CQueueInterface_inherit__map">
<area shape="rect" id="node3" href="classDrush_1_1Queue_1_1QueueBase.html" title="Drush\\Queue\\QueueBase" alt="" coords="79,83,249,112"/><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"/></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:a4e69111579de6c21475468b17c438efb"><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"><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"><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>
<tr class="memitem:a240f44a88064a7b96fe2cb66f6a6ffcb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceDrush_1_1Queue_1_1QueueInterface.html#a240f44a88064a7b96fe2cb66f6a6ffcb">getInfo</a> ($name)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines an interface for interacting with queues. </p>

<p>Definition at line <a class="el" href="QueueInterface_8php_source.html#l00008">8</a> of file <a class="el" href="QueueInterface_8php_source.html">QueueInterface.php</a>.</p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a240f44a88064a7b96fe2cb66f6a6ffcb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Queue\QueueInterface::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.</p>
<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>Implemented in <a class="el" href="classDrush_1_1Queue_1_1QueueBase.html#ac7a9bceaefa8864c29cc6a403c524fe9">Drush\Queue\QueueBase</a>.</p>

</div>
</div>
<a class="anchor" id="ad564c199335ca8e2acd0238fb739f801"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Queue\QueueInterface::getQueue </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.</p>
<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>Implemented in <a class="el" href="classDrush_1_1Queue_1_1Queue8.html#ad504bdacf0f5201abc67d543a942f397">Drush\Queue\Queue8</a>, and <a class="el" href="classDrush_1_1Queue_1_1Queue7.html#a14f5cbd3239e35d3d457dfa64169b812">Drush\Queue\Queue7</a>.</p>

<p>Referenced by <a class="el" href="QueueBase_8php_source.html#l00017">Drush\Queue\QueueBase\listQueues()</a>.</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="interfaceDrush_1_1Queue_1_1QueueInterface_ad564c199335ca8e2acd0238fb739f801_icgraph.png" border="0" usemap="#interfaceDrush_1_1Queue_1_1QueueInterface_ad564c199335ca8e2acd0238fb739f801_icgraph" alt=""/></div>
<map name="interfaceDrush_1_1Queue_1_1QueueInterface_ad564c199335ca8e2acd0238fb739f801_icgraph" id="interfaceDrush_1_1Queue_1_1QueueInterface_ad564c199335ca8e2acd0238fb739f801_icgraph">
<area shape="rect" id="node3" href="classDrush_1_1Queue_1_1QueueBase.html#adac1fcecf8ecc53cdbf291819aacb921" title="Drush\\Queue\\QueueBase\l\\listQueues" alt="" coords="245,5,416,51"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a4e69111579de6c21475468b17c438efb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Queue\QueueInterface::getQueues </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns all queues. </p>

<p>Implemented in <a class="el" href="classDrush_1_1Queue_1_1Queue8.html#a07ec397f71138e3817ef1e8986b1f3bf">Drush\Queue\Queue8</a>, and <a class="el" href="classDrush_1_1Queue_1_1Queue7.html#aa6edcebc7dadfd6e69d14d6e8b6cbe85">Drush\Queue\Queue7</a>.</p>

<p>Referenced by <a class="el" href="QueueBase_8php_source.html#l00033">Drush\Queue\QueueBase\getInfo()</a>, and <a class="el" href="QueueBase_8php_source.html#l00017">Drush\Queue\QueueBase\listQueues()</a>.</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="interfaceDrush_1_1Queue_1_1QueueInterface_a4e69111579de6c21475468b17c438efb_icgraph.png" border="0" usemap="#interfaceDrush_1_1Queue_1_1QueueInterface_a4e69111579de6c21475468b17c438efb_icgraph" alt=""/></div>
<map name="interfaceDrush_1_1Queue_1_1QueueInterface_a4e69111579de6c21475468b17c438efb_icgraph" id="interfaceDrush_1_1Queue_1_1QueueInterface_a4e69111579de6c21475468b17c438efb_icgraph">
<area shape="rect" id="node3" href="classDrush_1_1Queue_1_1QueueBase.html#ac7a9bceaefa8864c29cc6a403c524fe9" title="Drush\\Queue\\QueueBase\l\\getInfo" alt="" coords="245,5,416,51"/><area shape="rect" id="node7" href="classDrush_1_1Queue_1_1QueueBase.html#adac1fcecf8ecc53cdbf291819aacb921" title="Drush\\Queue\\QueueBase\l\\listQueues" alt="" coords="245,74,416,121"/><area shape="rect" id="node5" href="classDrush_1_1Queue_1_1Queue7.html#ac02b12a233a3570608360b451052fd73" title="Drush\\Queue\\Queue7\\run" alt="" coords="464,13,635,43"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a1e369ebf8640151ae6a605c69a025265"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Queue\QueueInterface::run </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$time_limit</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Runs a given queue.</p>
<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>
    <tr><td class="paramtype">int</td><td class="paramname">$time_limit</td><td>The maximum number of seconds that the queue can run. By default the queue will be run as long as possible.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int The number of items successfully processed from the queue. </dd></dl>

<p>Implemented in <a class="el" href="classDrush_1_1Queue_1_1Queue8.html#a4abe7b97a741965b3ba4f36aae398810">Drush\Queue\Queue8</a>, and <a class="el" href="classDrush_1_1Queue_1_1Queue7.html#ac02b12a233a3570608360b451052fd73">Drush\Queue\Queue7</a>.</p>

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