PHP Interface DMS\Filter\Mapping\ClassMetadataInterface

Show file Open project: rdohms/dms-filter Interface Usage Examples

Public Methods

Method Description
addPropertyRule ( string $property, Rule $rule ) Adds a new rule to a property
getClassName ( ) : string Get name of class represented in this Metadata object
getFilteredProperties ( ) : array Retrieve a list of the object's properties that have filters attached to them
getPropertyRules ( string $property ) : array Retrieve s list of filtering rules attached to a property
getReflectionClass ( ) : ReflectionClas\ReflectionClass Returns a ReflectionClass instance for this class.
mergeRules ( DMS\Filter\Mapping\ClassMetadataInterface $metadata ) Merges rules from another metadata object into this one

Method Details

addPropertyRule() public method

Adds a new rule to a property
public addPropertyRule ( string $property, Rule $rule )
$property string
$rule DMS\Filter\Rules\Rule

getClassName() public method

Get name of class represented in this Metadata object
public getClassName ( ) : string
return string

getFilteredProperties() public method

Retrieve a list of the object's properties that have filters attached to them
public getFilteredProperties ( ) : array
return array

getPropertyRules() public method

Retrieve s list of filtering rules attached to a property
public getPropertyRules ( string $property ) : array
$property string
return array

getReflectionClass() public method

Returns a ReflectionClass instance for this class.
public getReflectionClass ( ) : ReflectionClas\ReflectionClass
return ReflectionClas\ReflectionClass

mergeRules() public method

Merges rules from another metadata object into this one
public mergeRules ( DMS\Filter\Mapping\ClassMetadataInterface $metadata )
$metadata DMS\Filter\Mapping\ClassMetadataInterface