Drush: drush_outputformat Class Reference

  1. 7.x doxygen/html/classdrush__outputformat.html
  2. master doxygen/html/classdrush__outputformat.html
drush_outputformat Class Reference
Inheritance diagram for drush_outputformat:

Public Member Functions

 __construct ($config)
 format_error ($message)
 formatter_type ()
 is_list ()
 formatter_is_simple_list ()
 data_type ($metadata)
 supported_data_types ($metadata=NULL)
 supports_single_only ($metadata=NULL)
 get_info ($key)
 process ($input, $metadata=array())
 format ($input, $metadata)

Detailed Description

Interface for output format engines.

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

Member Function Documentation

drush_outputformat::process (   $input,
  $metadata = array() 
)

Perform pre-processing and then format() the $input.

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

References drush_get_context(), drush_get_option(), drush_hide_output_fields(), and drush_unset_recursive().

Here is the call graph for this function:


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

File

doxygen/html/classdrush__outputformat.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_outputformat 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><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="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>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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdrush__outputformat-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">drush_outputformat Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for drush_outputformat:</div>
<div class="dyncontent">
<div class="center"><img src="classdrush__outputformat__inherit__graph.png" border="0" usemap="#drush__outputformat_inherit__map" alt="Inheritance graph"/></div>
<map name="drush__outputformat_inherit__map" id="drush__outputformat_inherit__map">
<area shape="rect" id="node3" href="classdrush__outputformat__csv__or__string.html" title="drush_outputformat\l_csv_or_string" alt="" coords="208,5,341,51"/><area shape="rect" id="node5" href="classdrush__outputformat__json.html" title="drush_outputformat_json" alt="" coords="192,75,357,104"/><area shape="rect" id="node7" href="classdrush__outputformat__key__value.html" title="drush_outputformat\l_key_value" alt="" coords="208,127,341,174"/><area shape="rect" id="node9" href="classdrush__outputformat__list.html" title="drush_outputformat_list" alt="" coords="196,197,353,227"/><area shape="rect" id="node11" href="classdrush__outputformat__message.html" title="drush_outputformat\l_message" alt="" coords="208,250,341,297"/><area shape="rect" id="node13" href="classdrush__outputformat__php.html" title="drush_outputformat_php" alt="" coords="193,320,356,349"/><area shape="rect" id="node15" href="classdrush__outputformat__print__r.html" title="drush_outputformat\l_print_r" alt="" coords="208,373,341,419"/><area shape="rect" id="node17" href="classdrush__outputformat__string.html" title="drush_outputformat\l_string" alt="" coords="208,442,341,489"/><area shape="rect" id="node19" href="classdrush__outputformat__table.html" title="drush_outputformat\l_table" alt="" coords="208,511,341,558"/><area shape="rect" id="node21" href="classdrush__outputformat__var__export.html" title="drush_outputformat\l_var_export" alt="" coords="208,581,341,627"/><area shape="rect" id="node23" href="classdrush__outputformat__variables.html" title="drush_outputformat\l_variables" alt="" coords="208,650,341,697"/><area shape="rect" id="node25" href="classdrush__outputformat__yaml.html" title="drush_outputformat_yaml" alt="" coords="191,720,359,749"/></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:a17ff3f6c244cfeb9dd0861547c1ce5c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17ff3f6c244cfeb9dd0861547c1ce5c3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>__construct</b> ($config)</td></tr>
<tr class="memitem:a9b22cbd411beefbd537cf1dbfc38fc6a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b22cbd411beefbd537cf1dbfc38fc6a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>format_error</b> ($message)</td></tr>
<tr class="memitem:ab46bf4f58bea0fdaaad41a0904125fb7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab46bf4f58bea0fdaaad41a0904125fb7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>formatter_type</b> ()</td></tr>
<tr class="memitem:a3b24b4c73c52c5632576a04df626568c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b24b4c73c52c5632576a04df626568c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>is_list</b> ()</td></tr>
<tr class="memitem:af474602d2946fda39d166830031c59e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af474602d2946fda39d166830031c59e1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>formatter_is_simple_list</b> ()</td></tr>
<tr class="memitem:a9c203b3383498faa1d58e51c4e6c024f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c203b3383498faa1d58e51c4e6c024f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>data_type</b> ($metadata)</td></tr>
<tr class="memitem:ae93d661aacea9b8c5b586dd2fc905614"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae93d661aacea9b8c5b586dd2fc905614"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>supported_data_types</b> ($metadata=NULL)</td></tr>
<tr class="memitem:a822391561c00c1cc3b6f1a436dcbcc94"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a822391561c00c1cc3b6f1a436dcbcc94"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>supports_single_only</b> ($metadata=NULL)</td></tr>
<tr class="memitem:ad66801d1a675bfc8a2a90cdf1617be85"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad66801d1a675bfc8a2a90cdf1617be85"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>get_info</b> ($key)</td></tr>
<tr class="memitem:a69d8dba156e7b5aabb76fea0f52cfd68"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrush__outputformat.html#a69d8dba156e7b5aabb76fea0f52cfd68">process</a> ($input, $metadata=array())</td></tr>
<tr class="memitem:a7fcad46e7fa314dfd00678c1d9b57208"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fcad46e7fa314dfd00678c1d9b57208"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>format</b> ($input, $metadata)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface for output format engines. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00341">341</a> of file <a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a>.</p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a69d8dba156e7b5aabb76fea0f52cfd68"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_outputformat::process </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$input</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>Perform pre-processing and then format() the $input. </p>

<p>Definition at line <a class="el" href="outputformat_8drush_8inc_source.html#l00407">407</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>, <a class="el" href="context_8inc_source.html#l00405">drush_get_option()</a>, <a class="el" href="outputformat_8drush_8inc_source.html#l00462">drush_hide_output_fields()</a>, and <a class="el" href="drush_8inc_source.html#l01871">drush_unset_recursive()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classdrush__outputformat_a69d8dba156e7b5aabb76fea0f52cfd68_cgraph.png" border="0" usemap="#classdrush__outputformat_a69d8dba156e7b5aabb76fea0f52cfd68_cgraph" alt=""/></div>
<map name="classdrush__outputformat_a69d8dba156e7b5aabb76fea0f52cfd68_cgraph" id="classdrush__outputformat_a69d8dba156e7b5aabb76fea0f52cfd68_cgraph">
<area shape="rect" id="node3" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="607,88,735,118"/><area shape="rect" id="node5" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8" title="drush_get_option" alt="" coords="213,87,333,116"/><area shape="rect" id="node12" href="outputformat_8drush_8inc.html#aa114eb117d61d2a796e638caf91f92d6" title="drush_hide_output_fields" alt="" coords="191,154,356,183"/><area shape="rect" id="node18" href="drush_8inc.html#a168e5c4e0711c44cf1c54ea8c4ff2c75" title="drush_unset_recursive" alt="" coords="197,207,349,236"/><area shape="rect" id="node7" href="context_8inc.html#aee5781894bf828bfa508d9052553f809" title="_drush_get_option" alt="" coords="417,62,545,91"/><area shape="rect" id="node9" href="context_8inc.html#a9f6272c1a68141ce873c07aae3a316ac" title="drush_context_names" alt="" coords="407,115,556,144"/><area shape="rect" id="node15" href="context_8inc.html#af983acfe90e7d7bbdbd67c57f93708ba" title="drush_set_context" alt="" coords="417,219,545,248"/></map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>commands/core/<a class="el" href="outputformat_8drush_8inc_source.html">outputformat.drush.inc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 8 2014 09:05:01 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>