Modules/Groupware/Email/Folder/Filter/Folder.php

Show: inherited
Table of Contents

\Conjoon_Modules_Groupware_Email_Folder_Filter_Folder

Package: Conjoon\Filter\Input

An input-filter class defining all validators and filters needed when processing input data for mutating or creating Email-Folders.

Parent(s)
\Conjoon_Filter_Input < \Zend_Filter_Input
Author
Thorsten Suckow-Homberg  
Category
Filter  
Uses
\Conjoon_Filter_Input  

Constants

Constant  CONTEXT_RENAME = 'rename'
Constant  CONTEXT_MOVE = 'move'
Constantstring  CONTEXT_CREATE = 'create'
inherited

Inherited from: \Conjoon_Filter_Input::CONTEXT_CREATE
Inherited_from
\Conjoon_Filter_Input::CONTEXT_CREATE  
string
Constantstring  CONTEXT_UPDATE = 'update'
inherited

Inherited from: \Conjoon_Filter_Input::CONTEXT_UPDATE
Inherited_from
\Conjoon_Filter_Input::CONTEXT_UPDATE  
string
Constantstring  CONTEXT_DELETE = 'delete'
inherited

Inherited from: \Conjoon_Filter_Input::CONTEXT_DELETE
Inherited_from
\Conjoon_Filter_Input::CONTEXT_DELETE  
string
Constantstring  CONTEXT_RESPONSE = 'response'
inherited

Inherited from: \Conjoon_Filter_Input::CONTEXT_RESPONSE
Inherited_from
\Conjoon_Filter_Input::CONTEXT_RESPONSE  
string

Properties

Propertyprotectedstring  $_context= ''''
inherited

Inherited from: \Conjoon_Filter_Input::$$_context
Default value''Details
Type
string
Inherited_from
\Conjoon_Filter_Input::$$_context  
Propertyprotectedarray  $_dontRecurseFilter= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\Conjoon_Filter_Input::$$_dontRecurseFilter  
Propertyprotectedarray  $_filters= 'array( 'id' => array( 'StringTrim' ), 'parentId' => array( 'StringTrim' ), 'name' => array( 'StringTrim' ), 'path' => array( 'SanitizeExtFolderPath' ), 'parentPath' => array( 'SanitizeExtFolderPath' ) )'

Default valuearray( 'id' => array( 'StringTrim' ), 'parentId' => array( 'StringTrim' ), 'name' => array( 'StringTrim' ), 'path' => array( 'SanitizeExtFolderPath' ), 'parentPath' => array( 'SanitizeExtFolderPath' ) )Details
Type
array
Propertyprotectedarray  $_presence= 'array( self::CONTEXT_RESPONSE => array( 'id', 'path' ), self::CONTEXT_RENAME => array( 'id', 'name', 'parentId', 'path' ), self::CONTEXT_CREATE => array( 'parentId', 'name', 'path' ), self::CONTEXT_MOVE => array( 'parentId', 'id', 'path', 'parentPath' ), self::CONTEXT_DELETE => array( 'id' ) )'

An associative array containing all fields which need to be available for each operation. Override this to adjust your filter bahavior.

Example:

$_presence = array( 'update' => array('field1', 'field2', 'field3'), 'create' => array('field4') );

The above array would tell the filter that field1, field2 and field3 have to be available (Meta command PRESENCE) when data is updated (i.e. edited), while only field4 has to be present when data is created.

Default valuearray( self::CONTEXT_RESPONSE => array( 'id', 'path' ), self::CONTEXT_RENAME => array( 'id', 'name', 'parentId', 'path' ), self::CONTEXT_CREATE => array( 'parentId', 'name', 'path' ), self::CONTEXT_MOVE => array( 'parentId', 'id', 'path', 'parentPath' ), self::CONTEXT_DELETE => array( 'id' ) )Details
Type
array
Propertyprotectedarray  $_validators= 'array( 'id' => array( 'allowEmpty' => false ), 'parentId' => array( 'allowEmpty' => false ), 'name' => array( 'allowEmpty' => false ), 'path' => array( 'allowEmpty' => false ), 'parentPath' => array( 'allowEmpty' => false ) )'

Default valuearray( 'id' => array( 'allowEmpty' => false ), 'parentId' => array( 'allowEmpty' => false ), 'name' => array( 'allowEmpty' => false ), 'path' => array( 'allowEmpty' => false ), 'parentPath' => array( 'allowEmpty' => false ) )Details
Type
array

Methods

methodpublic__construct( array $data,  $context, array $options = null ) : void
inherited

Constructor.

Inherited from: \Conjoon_Filter_Input::__construct()
Parameters
Name Type Description
$data array

OPTIONAL

$context
$options array

OPTIONAL

methodprotected_adjustValidators( ) : void
inherited

Inherited from: \Conjoon_Filter_Input::_adjustValidators()
methodprotected_filter( ) : void
inherited

Inherited from: \Conjoon_Filter_Input::_filter()
methodprotected_filterRule( array $filterRule ) : void
inherited

Override to consider _dontRecurseFilter - where field names are stored where filters should not be operated on array values.

Inherited from: \Conjoon_Filter_Input::_filterRule()
Parameters
Name Type Description
$filterRule array
methodprotected_init( ) : void

methodprotected_preProcess( ) : void
inherited

Inherited from: \Conjoon_Filter_Input::_preProcess()
methodpublicgetProcessedData( ) : void
inherited

Inherited from: \Conjoon_Filter_Input::getProcessedData()
methodpublicprocess( ) : \Zend_Filter_Input
inherited

Overrides parent implementation by adding a call to _preProcess before the data gets processed.

Inherited from: \Conjoon_Filter_Input::process()
Returns
Type Description
\Zend_Filter_Input
Throws
Exception Description
\Zend_Filter_Exception
Documentation was generated by DocBlox 0.18.1.