Drush: Drush\Config\StorageFilter Interface Reference

Inheritance diagram for Drush\Config\StorageFilter:

Public Member Functions

 filterRead ($name, $data)
 filterWrite ($name, array $data, StorageInterface $storage)

Detailed Description

Definition at line 12 of file StorageFilter.php.

Member Function Documentation

Drush\Config\StorageFilter::filterRead (   $name,
  $data 
)

Filters configuration data after it is read from storage.

Parameters
string$nameThe name of a configuration object to load.
array$dataThe configuration data to filter.
Returns
array $data The filtered data.

Implemented in Drush\Config\CoreExtensionFilter.

Drush\Config\StorageFilter::filterWrite (   $name,
array  $data,
StorageInterface  $storage 
)

Filter configuration data before it is written to storage.

Parameters
string$nameThe name of a configuration object to save.
array$dataThe configuration data to filter.
StorageInterfaceThe storage object that the filtered data will be written to. Provided in case the filter needs to read the existing configuration before writing it.
Returns
array $data The filtered data.

Implemented in Drush\Config\CoreExtensionFilter.


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

File

doxygen/html/interfaceDrush_1_1Config_1_1StorageFilter.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\Config\StorageFilter 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>Config</b></li><li class="navelem"><a class="el" href="interfaceDrush_1_1Config_1_1StorageFilter.html">StorageFilter</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_1Config_1_1StorageFilter-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Drush\Config\StorageFilter Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Drush\Config\StorageFilter:</div>
<div class="dyncontent">
<div class="center"><img src="interfaceDrush_1_1Config_1_1StorageFilter__inherit__graph.png" border="0" usemap="#Drush_0CConfig_0CStorageFilter_inherit__map" alt="Inheritance graph"/></div>
<map name="Drush_0CConfig_0CStorageFilter_inherit__map" id="Drush_0CConfig_0CStorageFilter_inherit__map">
<area shape="rect" id="node3" href="classDrush_1_1Config_1_1CoreExtensionFilter.html" title="Drush\\Config\\CoreExtension\lFilter" alt="" coords="5,83,195,130"/></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:a8261bad9a489bb220e4eb9df93818a08"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceDrush_1_1Config_1_1StorageFilter.html#a8261bad9a489bb220e4eb9df93818a08">filterRead</a> ($name, $data)</td></tr>
<tr class="memitem:a7ea6f5b9340e22e977b5985c42867062"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceDrush_1_1Config_1_1StorageFilter.html#a7ea6f5b9340e22e977b5985c42867062">filterWrite</a> ($name, array $data, StorageInterface $storage)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="StorageFilter_8php_source.html#l00012">12</a> of file <a class="el" href="StorageFilter_8php_source.html">StorageFilter.php</a>.</p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="a8261bad9a489bb220e4eb9df93818a08"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Config\StorageFilter::filterRead </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>$data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Filters configuration data after it is read from storage.</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 a configuration object to load. </td></tr>
    <tr><td class="paramtype">array</td><td class="paramname">$data</td><td>The configuration data to filter.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array $data The filtered data. </dd></dl>

<p>Implemented in <a class="el" href="classDrush_1_1Config_1_1CoreExtensionFilter.html#a7941d4860eb3807c85a83d1139615875">Drush\Config\CoreExtensionFilter</a>.</p>

</div>
</div>
<a class="anchor" id="a7ea6f5b9340e22e977b5985c42867062"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Drush\Config\StorageFilter::filterWrite </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">array&#160;</td>
          <td class="paramname"><em>$data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">StorageInterface&#160;</td>
          <td class="paramname"><em>$storage</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Filter configuration data before it is written to storage.</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 a configuration object to save. </td></tr>
    <tr><td class="paramtype">array</td><td class="paramname">$data</td><td>The configuration data to filter. </td></tr>
    <tr><td class="paramtype"></td><td class="paramname">StorageInterface</td><td>The storage object that the filtered data will be written to. Provided in case the filter needs to read the existing configuration before writing it.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array $data The filtered data. </dd></dl>

<p>Implemented in <a class="el" href="classDrush_1_1Config_1_1CoreExtensionFilter.html#a0a35fc17f2675a1a900a4ce43b84a53e">Drush\Config\CoreExtensionFilter</a>.</p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>lib/Drush/Config/<a class="el" href="StorageFilter_8php_source.html">StorageFilter.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 2 2016 07:30:14 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>