Filter/Input.php

Show: inherited
Table of Contents

\Conjoon_Filter_Input

Package: Conjoon\Filter

A custom filter implementation that allows for switching context - either 'update' or 'create' - to autmoatically prepare and validate data before any operation with it happens.

Parent(s)
\Zend_Filter_Input
Children
\Conjoon_Modules_Service_Twitter_Account_Filter_Account
\Conjoon_Modules_Service_Twitter_Tweet_Filter_Tweet
\Conjoon_Modules_Groupware_Files_File_Filter_File
\Conjoon_Modules_Groupware_Email_Message_Filter_MessageResponse
\Conjoon_Modules_Groupware_Email_Account_Filter_Account
\Conjoon_Modules_Groupware_Email_Folder_Filter_Folder
\Conjoon_Modules_Groupware_Email_Item_Filter_Request
\Conjoon_Modules_Groupware_Email_Item_Filter_ItemResponse
\Conjoon_Modules_Groupware_Email_Item_Filter_Item
\Conjoon_Modules_Groupware_Email_Item_Filter_Flag
\Conjoon_Modules_Groupware_Email_Item_Filter_Inbox
\Conjoon_Modules_Groupware_Email_Draft_Filter_DraftResponse
\Conjoon_Modules_Groupware_Email_Draft_Filter_DraftInput
\Conjoon_Modules_Groupware_Email_Attachment_Filter_AttachmentResponse
\Conjoon_Modules_Groupware_Email_Attachment_Filter_Attachment
\Conjoon_Modules_Groupware_Feeds_Account_Filter_Account
\Conjoon_Modules_Groupware_Feeds_Item_Filter_Item
\Conjoon_Modules_Default_Registry_Filter_Registry
\Conjoon_Modules_Default_ApplicationCache_Filter
Category
Filter  
Used_by
\Conjoon_Modules_Service_Twitter_Account_Filter_Account  
Used_by
\Conjoon_Modules_Service_Twitter_Tweet_Filter_Tweet  
Used_by
\Conjoon_Modules_Groupware_Files_File_Filter_File  
Used_by
\Conjoon_Modules_Groupware_Email_Message_Filter_MessageResponse  
Used_by
\Conjoon_Modules_Groupware_Email_Account_Filter_Account  
Used_by
\Conjoon_Modules_Groupware_Email_Folder_Filter_Folder  
Used_by
\Conjoon_Modules_Groupware_Email_Item_Filter_Request  
Used_by
\Conjoon_Modules_Groupware_Email_Item_Filter_ItemResponse  
Used_by
\Conjoon_Modules_Groupware_Email_Item_Filter_Item  
Used_by
\Conjoon_Modules_Groupware_Email_Item_Filter_Flag  
Used_by
\Conjoon_Modules_Groupware_Email_Item_Filter_Inbox  
Used_by
\Conjoon_Modules_Groupware_Email_Draft_Filter_DraftResponse  
Used_by
\Conjoon_Modules_Groupware_Email_Draft_Filter_DraftInput  
Used_by
\Conjoon_Modules_Groupware_Email_Attachment_Filter_AttachmentResponse  
Used_by
\Conjoon_Modules_Groupware_Email_Attachment_Filter_Attachment  
Used_by
\Conjoon_Modules_Groupware_Feeds_Account_Filter_Account  
Used_by
\Conjoon_Modules_Groupware_Feeds_Item_Filter_Item  
Used_by
\Conjoon_Modules_Default_Registry_Filter_Registry  
Used_by
\Conjoon_Modules_Default_ApplicationCache_Filter  
Uses
\Zend_Filter_Input  

Constants

Constantstring  CONTEXT_CREATE = 'create'

string
Constantstring  CONTEXT_UPDATE = 'update'

string
Constantstring  CONTEXT_DELETE = 'delete'

string
Constantstring  CONTEXT_RESPONSE = 'response'

string

Properties

Propertyprotectedstring  $_context= ''''

Default value''Details
Type
string
Propertyprotectedarray  $_dontRecurseFilter= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_filters= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_presence= 'array()'

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()Details
Type
array
Propertyprotectedarray  $_validators= 'array()'

Default valuearray()Details
Type
array

Methods

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

Constructor.

Parameters
Name Type Description
$data array

OPTIONAL

$context
$options array

OPTIONAL

methodprotected_adjustValidators( ) : void

methodprotected_filter( ) : void

methodprotected_filterRule( array $filterRule ) : void

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

Parameters
Name Type Description
$filterRule array
methodprotected_init( ) : void

methodprotected_preProcess( ) : void

methodpublicgetProcessedData( ) : void

methodpublicprocess( ) : \Zend_Filter_Input

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

Returns
Type Description
\Zend_Filter_Input
Throws
Exception Description
\Zend_Filter_Exception
Documentation was generated by DocBlox 0.18.1.