PHP Interface DMS\Filter\FilterInterface

Datei anzeigen Open project: rdohms/dms-filter Interface Usage Examples

Public Methods

Method Description
filterEntity ( mixed $object ) Iterates over the properties of the object applying filters and replacing values
filterProperty ( mixed $object, string $property ) Filters a specific property in an object, replacing the current value
filterValue ( mixed $value, array | Rule $filter ) : mixed Runs a given value through one or more filter rules returning the filtered value
getMetadataFactory ( ) : DMS\Filter\Mapping\ClassMetadataFactoryInterface Retrieves the metadata factory for class metdatas

Method Details

filterEntity() public method

Iterates over the properties of the object applying filters and replacing values
public filterEntity ( mixed $object )
$object mixed

filterProperty() public method

Filters a specific property in an object, replacing the current value
public filterProperty ( mixed $object, string $property )
$object mixed
$property string

filterValue() public method

Runs a given value through one or more filter rules returning the filtered value
public filterValue ( mixed $value, array | Rule $filter ) : mixed
$value mixed
$filter array | DMS\Filter\Rules\Rule
return mixed

getMetadataFactory() public method

Retrieves the metadata factory for class metdatas
public getMetadataFactory ( ) : DMS\Filter\Mapping\ClassMetadataFactoryInterface
return DMS\Filter\Mapping\ClassMetadataFactoryInterface