FilterHelper Class Reference

Public Member Functions
	compareFilters (&$filterA, $filterBSettings, &$filterBSubfilters)
&	configureFilter ($filterNode, $persist=true)
	getFilterSetting ($settingNode)
	installFilterGroups ($filterGroupsNode)
	readArraySetting ($arrayNode)

Detailed Description

Class that provides filter-related helper methods.

Definition at line 15 of file FilterHelper.inc.php.

Member Function Documentation

compareFilters()

FilterHelper::compareFilters	(	&	$filterA,
			$filterBSettings,
		&	$filterBSubfilters
	)

Recursively compares two filters (filter A and filter B) based on their settings and sub-filters.

Parameters

$filterA	PersistableFilter
$filterBSettings	array an array of key/value pairs
$filterBSubfilters	array an array of filters

Returns

boolean true if the two transformations are identical, false otherwise

Definition at line 141 of file FilterHelper.inc.php.

Referenced by configureFilter().

configureFilter()

& FilterHelper::configureFilter	(		$filterNode,
			$persist = true
	)

* Helper method that configures and optionally
* installs a filter based on the given XML node
* which represents a <filter> element.
* 

Parameters

$filterNode	XMLNode
$persist	boolean whether to install the filter

Returns

PersistableFilter the installed filter.

Definition at line 63 of file FilterHelper.inc.php.

References compareFilters(), DAORegistry\getDAO(), getFilterSetting(), and PKPString\regexp_match().

getFilterSetting()

FilterHelper::getFilterSetting

(

$settingNode

)

* Helper method that extracts filter settings
* from the children of a <filter> element.
* 

Parameters

$settingNode

XMLNode

Returns

$setting array a key-value pair.

Definition at line 191 of file FilterHelper.inc.php.

References readArraySetting().

Referenced by configureFilter().

installFilterGroups()

FilterHelper::installFilterGroups

(

$filterGroupsNode

)

* Helper method that installs filter groups based on
* the given XML node which represents a <filterGroups>
* element.
* 

Parameters

$filterGroupsNode

XMLNode

Definition at line 24 of file FilterHelper.inc.php.

References DAORegistry\getDAO().

readArraySetting()

FilterHelper::readArraySetting

(

$arrayNode

)

Recursively read an array from an XML element list.

Parameters

$arrayNode

XMLNode

Returns

array

Definition at line 242 of file FilterHelper.inc.php.

Referenced by getFilterSetting().

---

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

• FilterHelper.inc.php