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

  1. 7.x doxygen/html/outputformat_8drush_8inc.html
  2. master doxygen/html/outputformat_8drush_8inc.html

Go to the source code of this file.

Classes

class  drush_outputformat

Functions

 drush_get_outputformat ()
 drush_set_default_outputformat ($format, $metadata=array())
 drush_get_command_format_metadata ($command, $metadata=array())
 outputformat_drush_engine_type_info ()
 outputformat_drush_engine_outputformat ()
 outputformat_drush_command_alter (&$command)
 outputformat_drush_help_alter (&$command)
 outputformat_drush_engine_topic_additional_text ($engine, $instance, $config)
 drush_hide_output_fields ($fields_to_hide=array())

Detailed Description

Core drush output formats.

Definition in file outputformat.drush.inc.

Function Documentation

drush_get_command_format_metadata (   $command,
  $metadata = array() 
)

Given a command name or a command record, return the command formatter that is used to process that command's output.

Definition at line 29 of file outputformat.drush.inc.

References drush_get_command_engine_config(), and drush_get_commands().

Referenced by drush_core_status().

Here is the call graph for this function:

Here is the caller graph for this function:

drush_get_outputformat ( )
Returns
drush_outputformat The selected output format engine

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

References drush_get_engine().

Referenced by drush_handle_command_output().

Here is the call graph for this function:

Here is the caller graph for this function:

drush_hide_output_fields (   $fields_to_hide = array())

Specify that certain fields should not appear in the resulting output.

Definition at line 462 of file outputformat.drush.inc.

References drush_get_context(), and drush_set_context().

Referenced by drush_pm_list(), and drush_outputformat\process().

Here is the call graph for this function:

Here is the caller graph for this function:

drush_set_default_outputformat (   $format,
  $metadata = array() 
)

Dynamically switch to a new output format. Does NOT override user-selected output format.

Definition at line 19 of file outputformat.drush.inc.

References drush_get_command(), and drush_load_command_engine().

Referenced by _drush_sitealias_user_specified_list(), and drush_views_execute().

Here is the call graph for this function:

Here is the caller graph for this function:

outputformat_drush_command_alter ( $command)

Implements hook_drush_command_alter

Definition at line 243 of file outputformat.drush.inc.

References drush_get_context().

Here is the call graph for this function:

outputformat_drush_engine_outputformat ( )

Implements hook_drush_engine_ENGINE_TYPE().

The output format types supported are represented by the 'engine-capabilities' of the output format engine. The different capabilities include:

format-single: A simple string.

format-list: An associative array where the key is usually the row label, and the value is a simple string. Some list formatters render the label, and others (like "list" and "csv") throw it away.

format-table: An associative array, where the key is the row id, and the value is the column data. The column data is also an associative array where the key is the column id and the value is the cell data. The cell data should usually be a simple string; however, some formatters can recursively format their cell contents before rendering (e.g. if a cell contains a list of items in an array).

These definitions align with the declared 'output-data-type' declared in command records.

See Also
drush_parse_command().

Any output format that does not declare any engine capabilities is expected to be able to render any php data structure that is passed to it.

Definition at line 116 of file outputformat.drush.inc.

outputformat_drush_engine_topic_additional_text (   $engine,
  $instance,
  $config 
)

Implements hook_drush_engine_topic_additional_text().

Definition at line 320 of file outputformat.drush.inc.

References drush_format(), and dt().

Here is the call graph for this function:

outputformat_drush_engine_type_info ( )

Implementation of hook_drush_engine_type_info().

Definition at line 40 of file outputformat.drush.inc.

outputformat_drush_help_alter ( $command)

Implements hook_drush_help_alter().

Definition at line 255 of file outputformat.drush.inc.

References dt().

Here is the call graph for this function:

File

doxygen/html/outputformat_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/outputformat.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="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><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="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">outputformat.drush.inc File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a href="outputformat_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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrush__outputformat.html">drush_outputformat</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9b9f691b2f676d97dc57dc3e60f57500"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#a9b9f691b2f676d97dc57dc3e60f57500">drush_get_outputformat</a> ()</td></tr>
<tr class="memitem:a46f0ffb5f8bf676a5dfec452b083a9f2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#a46f0ffb5f8bf676a5dfec452b083a9f2">drush_set_default_outputformat</a> ($format, $metadata=array())</td></tr>
<tr class="memitem:a4a9cc3871032fba8891b665d2606dcc0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#a4a9cc3871032fba8891b665d2606dcc0">drush_get_command_format_metadata</a> ($command, $metadata=array())</td></tr>
<tr class="memitem:a39c9d1e62b38e743b6131e52a83bbe69"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#a39c9d1e62b38e743b6131e52a83bbe69">outputformat_drush_engine_type_info</a> ()</td></tr>
<tr class="memitem:a2b6ff1dbfef77f4ddbebef3c1b5c450c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#a2b6ff1dbfef77f4ddbebef3c1b5c450c">outputformat_drush_engine_outputformat</a> ()</td></tr>
<tr class="memitem:aa5121e7cdbbb5b10e3186e5f9710d460"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#aa5121e7cdbbb5b10e3186e5f9710d460">outputformat_drush_command_alter</a> (&amp;$command)</td></tr>
<tr class="memitem:a57a9881b686a86fc37623da5f972556b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#a57a9881b686a86fc37623da5f972556b">outputformat_drush_help_alter</a> (&amp;$command)</td></tr>
<tr class="memitem:a5322ccb6b5616adf4bb2e959e42a214c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#a5322ccb6b5616adf4bb2e959e42a214c">outputformat_drush_engine_topic_additional_text</a> ($engine, $instance, $config)</td></tr>
<tr class="memitem:aa114eb117d61d2a796e638caf91f92d6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="outputformat_8drush_8inc.html#aa114eb117d61d2a796e638caf91f92d6">drush_hide_output_fields</a> ($fields_to_hide=array())</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Core drush output formats. </p>

<p>Definition in file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>
</div><h2>Function Documentation</h2>
<a class="anchor" id="a4a9cc3871032fba8891b665d2606dcc0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_get_command_format_metadata </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$command</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$metadata</em> = <code>array()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Given a command name or a command record, return the command formatter that is used to process that command's output. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00029">29</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

<p>References <a class="el" href="engines_8inc_source.html#l00134">drush_get_command_engine_config()</a>, and <a class="el" href="includes_2command_8inc_source.html#l00973">drush_get_commands()</a>.</p>

<p>Referenced by <a class="el" href="core_8drush_8inc_source.html#l00794">drush_core_status()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_cgraph.png" border="0" usemap="#outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_cgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_cgraph" id="outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_cgraph">
<area shape="rect" id="node3" href="engines_8inc.html#a316fd3a909b19c6b88ce4ffc521756da" title="drush_get_command_engine\l_config" alt="" coords="241,93,428,139"/><area shape="rect" id="node5" href="includes_2command_8inc.html#af0c377881e5c9c772f0cad80ea016452" title="drush_get_commands" alt="" coords="260,163,409,192"/><area shape="rect" id="node7" href="includes_2command_8inc.html#ad51d79509a4a134947703f3e58564444" title="drush_commandfile_list" alt="" coords="951,123,1108,152"/><area shape="rect" id="node11" href="includes_2command_8inc.html#a2ce77284c0002dda3a5d0527e583e017" title="drush_command_hook" alt="" coords="953,5,1105,35"/><area shape="rect" id="node13" href="engines_8inc.html#a04ee0e7019029ef27bc4e8f14341b2b4" title="drush_merge_engine_data" alt="" coords="479,201,652,231"/><area shape="rect" id="node48" href="includes_2command_8inc.html#aa89380abcf2e406ea2d6fe05d529f2b1" title="drush_command_translate" alt="" coords="479,305,652,335"/><area shape="rect" id="node9" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="1644,185,1772,215"/><area shape="rect" id="node15" href="engines_8inc.html#a50374de188af3d1cb754476607b9c375" title="drush_get_engine_types_info" alt="" coords="935,253,1124,283"/><area shape="rect" id="node19" href="engines_8inc.html#ae94a82d80d5e90cb126de1f16a7f8fe4" title="drush_get_engines" alt="" coords="728,175,859,204"/><area shape="rect" id="node33" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="1011,363,1048,392"/><area shape="rect" id="node44" href="engines_8inc.html#ac18b04b38c84979a32603cd5cef78c69" title="drush_find_engine_to_use" alt="" coords="707,329,880,359"/><area shape="rect" id="node17" href="includes_2command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9" title="drush_command_invoke_all" alt="" coords="1175,315,1356,344"/><area shape="rect" id="node22" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4" title="drush_set_error" alt="" coords="973,200,1085,229"/><area shape="rect" id="node26" href="backend_8inc.html#a38490210d77373f3d8492caf4e9a3190" title="drush_backend_packet" alt="" coords="1407,211,1561,240"/><area shape="rect" id="node29" href="group__logging.html#gad820f489a93518301794ada4ff7816b6" title="drush_log" alt="" coords="1227,261,1304,291"/><area shape="rect" id="node35" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="1199,367,1332,414"/><area shape="rect" id="node37" href="includes_2drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="1412,345,1556,375"/><area shape="rect" id="node40" href="includes_2drupal_8inc.html#aa7ac001ed15d678fa533b54d962eb5bc" title="drush_drupal_load_autoloader" alt="" coords="1611,345,1805,375"/><area shape="rect" id="node50" href="includes_2command_8inc.html#a643622feb3301c9b33e295e7f2bd7804" title="_drush_command_translate" alt="" coords="703,383,884,412"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_icgraph.png" border="0" usemap="#outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_icgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_icgraph" id="outputformat_8drush_8inc_a4a9cc3871032fba8891b665d2606dcc0_icgraph">
<area shape="rect" id="node3" href="core_8drush_8inc.html#aa7e3d1ac48eb92dab34abeb42f84cd3f" title="drush_core_status" alt="" coords="241,13,369,43"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a9b9f691b2f676d97dc57dc3e60f57500"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_get_outputformat </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdrush__outputformat.html">drush_outputformat</a> The selected output format engine </dd></dl>

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

<p>References <a class="el" href="engines_8inc_source.html#l00506">drush_get_engine()</a>.</p>

<p>Referenced by <a class="el" href="includes_2command_8inc_source.html#l00448">drush_handle_command_output()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_cgraph.png" border="0" usemap="#outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_cgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_cgraph" id="outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_cgraph">
<area shape="rect" id="node3" href="engines_8inc.html#a34ff5c6bb43688e04d0647eddf48d553" title="drush_get_engine" alt="" coords="215,5,337,35"/><area shape="rect" id="node5" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="388,5,516,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="outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_icgraph.png" border="0" usemap="#outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_icgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_icgraph" id="outputformat_8drush_8inc_a9b9f691b2f676d97dc57dc3e60f57500_icgraph">
<area shape="rect" id="node3" href="group__dispatching.html#gaec7e84c5668d8e13f33c948659112495" title="drush_handle_command\l_output" alt="" coords="213,5,376,51"/><area shape="rect" id="node5" href="group__dispatching.html#gac0d79cc522d6f5cecf9f72ecc5ecceb8" title="_drush_invoke_hooks" alt="" coords="425,13,572,43"/><area shape="rect" id="node7" href="group__dispatching.html#gae7a7f1f4b8c5edffbc2ececc6638698a" title="drush_command" alt="" coords="623,13,740,43"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="aa114eb117d61d2a796e638caf91f92d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_hide_output_fields </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$fields_to_hide</em> = <code>array()</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Specify that certain fields should not appear in the resulting output. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00462">462</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

<p>References <a class="el" href="context_8inc_source.html#l00328">drush_get_context()</a>, and <a class="el" href="context_8inc_source.html#l00293">drush_set_context()</a>.</p>

<p>Referenced by <a class="el" href="pm_8drush_8inc_source.html#l00718">drush_pm_list()</a>, and <a class="el" href="outputformat_8drush_8inc_source.html#l00407">drush_outputformat\process()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_cgraph.png" border="0" usemap="#outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_cgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_cgraph" id="outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_cgraph">
<area shape="rect" id="node3" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="401,5,529,35"/><area shape="rect" id="node5" href="context_8inc.html#af983acfe90e7d7bbdbd67c57f93708ba" title="drush_set_context" alt="" coords="223,31,351,60"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_icgraph.png" border="0" usemap="#outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_icgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_icgraph" id="outputformat_8drush_8inc_aa114eb117d61d2a796e638caf91f92d6_icgraph">
<area shape="rect" id="node3" href="pm_8drush_8inc.html#a61ebecaa80b51380169ddd81f751f0df" title="drush_pm_list" alt="" coords="239,5,340,35"/><area shape="rect" id="node5" href="classdrush__outputformat.html#a69d8dba156e7b5aabb76fea0f52cfd68" title="drush_outputformat\l\\process" alt="" coords="223,58,356,105"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a46f0ffb5f8bf676a5dfec452b083a9f2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_set_default_outputformat </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$metadata</em> = <code>array()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Dynamically switch to a new output format. Does NOT override user-selected output format. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00019">19</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

<p>References <a class="el" href="context_8inc_source.html#l00387">drush_get_command()</a>, and <a class="el" href="engines_8inc_source.html#l00146">drush_load_command_engine()</a>.</p>

<p>Referenced by <a class="el" href="sitealias_8drush_8inc_source.html#l00136">_drush_sitealias_user_specified_list()</a>, and <a class="el" href="views_8d8_8drush_8inc_source.html#l00264">drush_views_execute()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_cgraph.png" border="0" usemap="#outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_cgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_cgraph" id="outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_cgraph">
<area shape="rect" id="node3" href="context_8inc.html#a8fc57227375a540fea5314b154576354" title="drush_get_command" alt="" coords="263,96,404,126"/><area shape="rect" id="node7" href="engines_8inc.html#af4e4689479142932fa789c5e314d29e9" title="drush_load_command\l_engine" alt="" coords="259,254,408,301"/><area shape="rect" id="node5" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="1828,523,1956,552"/><area shape="rect" id="node9" href="group__logging.html#gad820f489a93518301794ada4ff7816b6" title="drush_log" alt="" coords="1408,730,1485,759"/><area shape="rect" id="node15" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="1192,367,1229,396"/><area shape="rect" id="node17" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="1380,388,1513,434"/><area shape="rect" id="node24" href="engines_8inc.html#a316fd3a909b19c6b88ce4ffc521756da" title="drush_get_command_engine\l_config" alt="" coords="457,93,644,140"/><area shape="rect" id="node26" href="engines_8inc.html#ae94a82d80d5e90cb126de1f16a7f8fe4" title="drush_get_engines" alt="" coords="925,523,1056,552"/><area shape="rect" id="node44" href="engines_8inc.html#afc75f35fe69601eee5e1c11a303dbbd0" title="drush_get_user_selected\l_engine" alt="" coords="468,804,633,850"/><area shape="rect" id="node55" href="engines_8inc.html#a1eb2ea4e50529f3c7953f419956ce51a" title="drush_set_engine" alt="" coords="719,315,841,344"/><area shape="rect" id="node57" href="context_8inc.html#af983acfe90e7d7bbdbd67c57f93708ba" title="drush_set_context" alt="" coords="927,315,1055,344"/><area shape="rect" id="node60" href="engines_8inc.html#af360562cce71af9828bbbb7326b1d7a8" title="drush_load_engine" alt="" coords="485,446,616,475"/><area shape="rect" id="node12" href="backend_8inc.html#a38490210d77373f3d8492caf4e9a3190" title="drush_backend_packet" alt="" coords="1589,679,1744,708"/><area shape="rect" id="node19" href="includes_2drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="1595,434,1739,463"/><area shape="rect" id="node22" href="includes_2drupal_8inc.html#aa7ac001ed15d678fa533b54d962eb5bc" title="drush_drupal_load_autoloader" alt="" coords="1795,434,1989,463"/><area shape="rect" id="node28" href="engines_8inc.html#a50374de188af3d1cb754476607b9c375" title="drush_get_engine_types_info" alt="" coords="1116,575,1305,604"/><area shape="rect" id="node32" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4" title="drush_set_error" alt="" coords="1155,628,1267,658"/><area shape="rect" id="node39" href="includes_2command_8inc.html#ad51d79509a4a134947703f3e58564444" title="drush_commandfile_list" alt="" coords="1588,523,1745,552"/><area shape="rect" id="node42" href="includes_2command_8inc.html#a2ce77284c0002dda3a5d0527e583e017" title="drush_command_hook" alt="" coords="1135,471,1287,500"/><area shape="rect" id="node30" href="includes_2command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9" title="drush_command_invoke_all" alt="" coords="1356,575,1537,604"/><area shape="rect" id="node46" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8" title="drush_get_option" alt="" coords="720,824,840,854"/><area shape="rect" id="node48" href="context_8inc.html#aee5781894bf828bfa508d9052553f809" title="_drush_get_option" alt="" coords="927,782,1055,811"/><area shape="rect" id="node51" href="context_8inc.html#a9f6272c1a68141ce873c07aae3a316ac" title="drush_context_names" alt="" coords="916,835,1065,864"/><area shape="rect" id="node63" href="engines_8inc.html#ac18b04b38c84979a32603cd5cef78c69" title="drush_find_engine_to_use" alt="" coords="693,472,867,502"/><area shape="rect" id="node67" href="commands_2core_2drupal_2environment_8inc.html#a643d851fd8dc63ea2ce8cf67aa33098c" title="drush_module_exists" alt="" coords="708,576,852,606"/><area shape="rect" id="node69" href="engines_8inc.html#a91df31f18b0a1d05540ccaf85e6d9a88" title="drush_include_engine" alt="" coords="707,419,853,448"/><area shape="rect" id="node74" href="drush_8inc.html#a80ce43b30f833522f72180811dab5a3e" title="drush_include" alt="" coords="940,470,1041,499"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_icgraph.png" border="0" usemap="#outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_icgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_icgraph" id="outputformat_8drush_8inc_a46f0ffb5f8bf676a5dfec452b083a9f2_icgraph">
<area shape="rect" id="node3" href="sitealias_8drush_8inc.html#abcb2a29ddfe9b3f66120793287c143c2" title="_drush_sitealias_user\l_specified_list" alt="" coords="260,5,407,51"/><area shape="rect" id="node7" href="views_8d8_8drush_8inc.html#aeb32a75a48c4c084de58193c6d8cfca2" title="drush_views_execute" alt="" coords="260,75,407,104"/><area shape="rect" id="node5" href="sitealias_8drush_8inc.html#a50bb1ab798f857c144715b783c71c480" title="drush_sitealias_print" alt="" coords="456,13,597,43"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="aa5121e7cdbbb5b10e3186e5f9710d460"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">outputformat_drush_command_alter </td>
          <td>(</td>
          <td class="paramtype">&amp;&#160;</td>
          <td class="paramname"><em>$command</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Implements hook_drush_command_alter </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00243">243</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

<p>References <a class="el" href="context_8inc_source.html#l00328">drush_get_context()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_aa5121e7cdbbb5b10e3186e5f9710d460_cgraph.png" border="0" usemap="#outputformat_8drush_8inc_aa5121e7cdbbb5b10e3186e5f9710d460_cgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_aa5121e7cdbbb5b10e3186e5f9710d460_cgraph" id="outputformat_8drush_8inc_aa5121e7cdbbb5b10e3186e5f9710d460_cgraph">
<area shape="rect" id="node3" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="191,13,319,43"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a2b6ff1dbfef77f4ddbebef3c1b5c450c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">outputformat_drush_engine_outputformat </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Implements <a class="el" href="group__hooks.html#gaf439b7c46ebd6bec9b332288ccb6355d">hook_drush_engine_ENGINE_TYPE()</a>.</p>
<p>The output format types supported are represented by the 'engine-capabilities' of the output format engine. The different capabilities include:</p>
<p>format-single: A simple string.</p>
<p>format-list: An associative array where the key is usually the row label, and the value is a simple string. Some list formatters render the label, and others (like "list" and "csv") throw it away.</p>
<p>format-table: An associative array, where the key is the row id, and the value is the column data. The column data is also an associative array where the key is the column id and the value is the cell data. The cell data should usually be a simple string; however, some formatters can recursively format their cell contents before rendering (e.g. if a cell contains a list of items in an array).</p>
<p>These definitions align with the declared 'output-data-type' declared in command records. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="includes_2command_8inc.html#aaf301462cb45c0da60e79ea868323858">drush_parse_command()</a>.</dd></dl>
<p>Any output format that does not declare any engine capabilities is expected to be able to render any php data structure that is passed to it. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00116">116</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

</div>
</div>
<a class="anchor" id="a5322ccb6b5616adf4bb2e959e42a214c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">outputformat_drush_engine_topic_additional_text </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$engine</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$config</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Implements hook_drush_engine_topic_additional_text(). </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00320">320</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

<p>References <a class="el" href="output_8inc_source.html#l00097">drush_format()</a>, and <a class="el" href="output_8inc_source.html#l00145">dt()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_a5322ccb6b5616adf4bb2e959e42a214c_cgraph.png" border="0" usemap="#outputformat_8drush_8inc_a5322ccb6b5616adf4bb2e959e42a214c_cgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a5322ccb6b5616adf4bb2e959e42a214c_cgraph" id="outputformat_8drush_8inc_a5322ccb6b5616adf4bb2e959e42a214c_cgraph">
<area shape="rect" id="node3" href="group__outputfunctions.html#ga9949217d2df2776bd355c4a3d50bba79" title="drush_format" alt="" coords="248,357,347,386"/><area shape="rect" id="node32" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="1051,515,1088,545"/><area shape="rect" id="node5" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8" title="drush_get_option" alt="" coords="400,71,520,101"/><area shape="rect" id="node13" href="engines_8inc.html#af360562cce71af9828bbbb7326b1d7a8" title="drush_load_engine" alt="" coords="395,357,525,386"/><area shape="rect" id="node21" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4" title="drush_set_error" alt="" coords="1013,254,1125,283"/><area shape="rect" id="node7" href="context_8inc.html#aee5781894bf828bfa508d9052553f809" title="_drush_get_option" alt="" coords="596,45,724,74"/><area shape="rect" id="node9" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="1684,250,1812,279"/><area shape="rect" id="node11" href="context_8inc.html#a9f6272c1a68141ce873c07aae3a316ac" title="drush_context_names" alt="" coords="585,98,735,127"/><area shape="rect" id="node15" href="engines_8inc.html#ae94a82d80d5e90cb126de1f16a7f8fe4" title="drush_get_engines" alt="" coords="795,357,925,386"/><area shape="rect" id="node46" href="engines_8inc.html#ac18b04b38c84979a32603cd5cef78c69" title="drush_find_engine_to_use" alt="" coords="573,463,747,493"/><area shape="rect" id="node50" href="commands_2core_2drupal_2environment_8inc.html#a643d851fd8dc63ea2ce8cf67aa33098c" title="drush_module_exists" alt="" coords="588,410,732,439"/><area shape="rect" id="node52" href="engines_8inc.html#a91df31f18b0a1d05540ccaf85e6d9a88" title="drush_include_engine" alt="" coords="587,357,733,386"/><area shape="rect" id="node60" href="engines_8inc.html#a1eb2ea4e50529f3c7953f419956ce51a" title="drush_set_engine" alt="" coords="599,151,721,181"/><area shape="rect" id="node17" href="engines_8inc.html#a50374de188af3d1cb754476607b9c375" title="drush_get_engine_types_info" alt="" coords="975,307,1164,337"/><area shape="rect" id="node41" href="includes_2command_8inc.html#ad51d79509a4a134947703f3e58564444" title="drush_commandfile_list" alt="" coords="1227,407,1384,437"/><area shape="rect" id="node44" href="includes_2command_8inc.html#a2ce77284c0002dda3a5d0527e583e017" title="drush_command_hook" alt="" coords="993,361,1145,390"/><area shape="rect" id="node19" href="includes_2command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9" title="drush_command_invoke_all" alt="" coords="1215,354,1396,383"/><area shape="rect" id="node25" href="backend_8inc.html#a38490210d77373f3d8492caf4e9a3190" title="drush_backend_packet" alt="" coords="1447,250,1601,279"/><area shape="rect" id="node28" href="group__logging.html#gad820f489a93518301794ada4ff7816b6" title="drush_log" alt="" coords="1267,301,1344,330"/><area shape="rect" id="node34" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="1239,460,1372,507"/><area shape="rect" id="node36" href="includes_2drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="1452,453,1596,482"/><area shape="rect" id="node39" href="includes_2drupal_8inc.html#aa7ac001ed15d678fa533b54d962eb5bc" title="drush_drupal_load_autoloader" alt="" coords="1651,453,1845,482"/><area shape="rect" id="node57" href="drush_8inc.html#a80ce43b30f833522f72180811dab5a3e" title="drush_include" alt="" coords="809,410,911,439"/><area shape="rect" id="node62" href="context_8inc.html#af983acfe90e7d7bbdbd67c57f93708ba" title="drush_set_context" alt="" coords="1460,146,1588,175"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a39c9d1e62b38e743b6131e52a83bbe69"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">outputformat_drush_engine_type_info </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Implementation of <a class="el" href="group__hooks.html#ga6512325eecb656befe244aad3e709bb1">hook_drush_engine_type_info()</a>. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00040">40</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

</div>
</div>
<a class="anchor" id="a57a9881b686a86fc37623da5f972556b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">outputformat_drush_help_alter </td>
          <td>(</td>
          <td class="paramtype">&amp;&#160;</td>
          <td class="paramname"><em>$command</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Implements <a class="el" href="group__hooks.html#ga013c29fff5780421e512662dffb3ee6c">hook_drush_help_alter()</a>. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00255">255</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>

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

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="outputformat_8drush_8inc_a57a9881b686a86fc37623da5f972556b_cgraph.png" border="0" usemap="#outputformat_8drush_8inc_a57a9881b686a86fc37623da5f972556b_cgraph" alt=""/></div>
<map name="outputformat_8drush_8inc_a57a9881b686a86fc37623da5f972556b_cgraph" id="outputformat_8drush_8inc_a57a9881b686a86fc37623da5f972556b_cgraph">
<area shape="rect" id="node3" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="191,32,228,61"/><area shape="rect" id="node5" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="279,23,412,70"/><area shape="rect" id="node7" href="includes_2drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="463,32,607,61"/><area shape="rect" id="node9" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="689,5,817,35"/><area shape="rect" id="node11" href="includes_2drupal_8inc.html#aa7ac001ed15d678fa533b54d962eb5bc" title="drush_drupal_load_autoloader" alt="" coords="656,59,851,88"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 8 2014 09:04:55 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>