Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

256 lines (241 sloc) 12.017 kB
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DMS</title><link rel="stylesheet" href="css/jquery-ui.css" type="text/css"></link><link rel="stylesheet" href="css/docblox/jquery-ui-1.8.16.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.tools.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
$(document).ready(function() {
$(".filetree").treeview({
collapsed: true,
persist: "cookie"
});
$("#accordion").accordion({
collapsible: true,
autoHeight: false,
fillSpace: true
});
$(".tabs").tabs();
});
</script></head><body><div xmlns="" id="content">
<script xmlns:dbx="http://docblox-project.org/xsl/functions">
function filterElements()
{
inherited = !$('#show-inherited').hasClass('deselected');
public = !$('#show-public').hasClass('deselected');
protected = !$('#show-protected').hasClass('deselected');
private = !$('#show-private').hasClass('deselected');
$('div.public').each(function(index, val) {
$(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
});
$('div.protected').each(function(index, val) {
$(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
});
$('div.private').each(function(index, val) {
$(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
});
}
$(document).ready(function() {
$('a.gripper').click(function() {
$(this).nextAll('div.code-tabs').slideToggle();
$(this).children('img').toggle();
return false;
});
$('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');
$('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
$(this).parent().nextAll('div.code-tabs').slideToggle();
$(this).parent().prevAll('a.gripper').children('img').toggle();
return false;
});
$('div.code-tabs').hide();
$('a.gripper').show();
$('div.code-tabs:empty').prevAll('a.gripper').html('');
$('#show-public, #show-protected, #show-private, #show-inherited')
.css('cursor', 'pointer')
.click(function(){
$(this).toggleClass('deselected');
if ($(this).hasClass('deselected')) {
$(this).fadeTo('fast', '0.4');
} else {
$(this).fadeTo('fast', '1.0');
}
filterElements();
return false;
});
$('#show-protected, #show-private').click();
// add the sliding behaviour to the file navigation and show it
// it is initially hidden for non-JS users.
$("#file-nav-box").show().hover(function() {
$("#file-nav-container").slideDown(400);
}, function() {
$("#file-nav-container").slideUp(400);
});
});
</script><h1 xmlns:dbx="http://docblox-project.org/xsl/functions" class="file">DMS/Bundle/FilterBundle/Service/Filter.php</h1>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" id="file-nav-box">
<div id="file-nav-options">
Show:
<img src="images/icons/visibility_public.png" id="show-public"><img src="images/icons/visibility_protected.png" id="show-protected"><img src="images/icons/visibility_private.png" id="show-private"><span class="attribute" id="show-inherited">inherited</span>
</div>
<div id="file-nav-container">
<ul id="file-nav"><li>
<a href="#classes"><img src="images/icons/class.png" height="14">
Classes
</a><ul><li><a href="#%5CDMS%5CBundle%5CFilterBundle%5CService%5CFilter">\DMS\Bundle\FilterBundle\Service\Filter</a></li></ul>
</li></ul>
<div style="clear: left;"></div>
</div>
<div id="file-nav-tab">
Table of Contents
</div>
</div>
<a xmlns:dbx="http://docblox-project.org/xsl/functions" name="top" class="anchor"></a><a name="classes" class="anchor"></a><a xmlns:dbx="http://docblox-project.org/xsl/functions" id="\DMS\Bundle\FilterBundle\Service\Filter" class="anchor"></a><h2 xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">\DMS\Bundle\FilterBundle\Service\Filter<div class="to-top"><a href="#top">jump to top</a></div>
</h2>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">
<small class="package"><b>Package: </b>DMS\Bundle</small><p class="short-description">Filter Service</p>
<div class="long-description"><p>Provides filtering result based on annotation in the class.</p></div>
<dl class="class-info"></dl>
<h3>Properties</h3>
<div>
<a id="\DMS\Bundle\FilterBundle\Service\Filter::$filterExecutor" class="anchor"></a><div class="property private">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_private.png" style="margin-right: 5px" alt="private">\DMS\Filter\Filter
 <span class="highlight">$filterExecutor</span>= ''
</code><div class="description">
<p class="short-description"></p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_DMS_Filter_Filter.html#%5CDMS%5CFilter%5CFilter">\DMS\Filter\Filter</a></dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
<h3>Methods</h3>
<div>
<a id="\DMS\Bundle\FilterBundle\Service\Filter::__construct()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">__construct</span><span class="nb-faded-text">(
)
</span>
:
void</code><div class="description"><p class="short_description">Instantiates the Filter Service</p></div>
<div class="code-tabs"><div class="long-description"></div></div>
<div class="clear"></div>
</div>
<a id="\DMS\Bundle\FilterBundle\Service\Filter::filterEntity()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">filterEntity</span><span class="nb-faded-text">(
object $object
)
</span>
:
void</code><div class="description"><p class="short_description">Filter an object based on its annotations</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$object</th>
<td>object</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\DMS\Bundle\FilterBundle\Service\Filter::filterProperty()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">filterProperty</span><span class="nb-faded-text">(
object $object, string $property
)
</span>
:
void</code><div class="description"><p class="short_description">Filters only a selected property of an entity</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$object</th>
<td>object</td>
<td><em></em></td>
</tr>
<tr>
<th>$property</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\DMS\Bundle\FilterBundle\Service\Filter::filterValue()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">filterValue</span><span class="nb-faded-text">(
mixed $value, <a href="db_DMS_Filter_Rules_Rule.html#%5CDMS%5CFilter%5CRules%5CRule">\DMS\Filter\Rules\Rule[]</a> | <a href="db_DMS_Filter_Rules_Rule.html#%5CDMS%5CFilter%5CRules%5CRule">\DMS\Filter\Rules\Rule</a> $filter
)
</span>
:
mixed</code><div class="description"><p class="short_description">Runs a given value through one or more filter rules returning the
filtered value</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$value</th>
<td>mixed</td>
<td><em></em></td>
</tr>
<tr>
<th>$filter</th>
<td>
<a href="db_DMS_Filter_Rules_Rule.html#%5CDMS%5CFilter%5CRules%5CRule">\DMS\Filter\Rules\Rule[]</a> | <a href="db_DMS_Filter_Rules_Rule.html#%5CDMS%5CFilter%5CRules%5CRule">\DMS\Filter\Rules\Rule</a>
</td>
<td><em></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>mixed</td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\DMS\Bundle\FilterBundle\Service\Filter::getFilterExecutor()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getFilterExecutor</span><span class="nb-faded-text">(
)
</span>
:
<a href="db_DMS_Filter_Filter.html#%5CDMS%5CFilter%5CFilter">\DMS\Filter\Filter</a></code><div class="description"><p class="short_description">Retrieve the actual filter executor instance</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_DMS_Filter_Filter.html#%5CDMS%5CFilter%5CFilter">\DMS\Filter\Filter</a></td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.18.1</a>.
</small></body></html>
Jump to Line
Something went wrong with that request. Please try again.