Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage
  • Mage_Adminhtml_Block_Html_Date
  • Mage_Adminhtml_Block_Html_Select
  • Mage_Api_Model_Wsdl_Config_Element
  • Mage_Captcha_Adminhtml_RefreshController
  • Mage_Captcha_RefreshController
  • Mage_Core_AjaxController
  • Mage_Core_Block_Abstract
  • Mage_Core_Block_Flush
  • Mage_Core_Block_Html_Calendar
  • Mage_Core_Block_Html_Date
  • Mage_Core_Block_Html_Link
  • Mage_Core_Block_Html_Select
  • Mage_Core_Block_Messages
  • Mage_Core_Block_Profiler
  • Mage_Core_Block_Store_Switcher
  • Mage_Core_Block_Template
  • Mage_Core_Block_Template_Facade
  • Mage_Core_Block_Template_Smarty
  • Mage_Core_Block_Template_Zend
  • Mage_Core_Block_Text
  • Mage_Core_Block_Text_List
  • Mage_Core_Block_Text_List_Item
  • Mage_Core_Block_Text_List_Link
  • Mage_Core_Block_Text_Tag
  • Mage_Core_Block_Text_Tag_Css
  • Mage_Core_Block_Text_Tag_Css_Admin
  • Mage_Core_Block_Text_Tag_Debug
  • Mage_Core_Block_Text_Tag_Js
  • Mage_Core_Block_Text_Tag_Meta
  • Mage_Core_Controller_Front_Action
  • Mage_Core_Controller_Front_Router
  • Mage_Core_Controller_Request_Http
  • Mage_Core_Controller_Response_Http
  • Mage_Core_Controller_Varien_Action
  • Mage_Core_Controller_Varien_Front
  • Mage_Core_Controller_Varien_Router_Abstract
  • Mage_Core_Controller_Varien_Router_Admin
  • Mage_Core_Controller_Varien_Router_Default
  • Mage_Core_Controller_Varien_Router_Standard
  • Mage_Core_Helper_Abstract
  • Mage_Core_Helper_Cookie
  • Mage_Core_Helper_Data
  • Mage_Core_Helper_File_Storage
  • Mage_Core_Helper_File_Storage_Database
  • Mage_Core_Helper_Hint
  • Mage_Core_Helper_Http
  • Mage_Core_Helper_Js
  • Mage_Core_Helper_String
  • Mage_Core_Helper_Translate
  • Mage_Core_Helper_Url
  • Mage_Core_Helper_Url_Rewrite
  • Mage_Core_IndexController
  • Mage_Core_Model_Abstract
  • Mage_Core_Model_App
  • Mage_Core_Model_App_Area
  • Mage_Core_Model_App_Emulation
  • Mage_Core_Model_Cache
  • Mage_Core_Model_Calculator
  • Mage_Core_Model_Config
  • Mage_Core_Model_Config_Base
  • Mage_Core_Model_Config_Data
  • Mage_Core_Model_Config_Element
  • Mage_Core_Model_Config_Options
  • Mage_Core_Model_Config_System
  • Mage_Core_Model_Cookie
  • Mage_Core_Model_Date
  • Mage_Core_Model_Design
  • Mage_Core_Model_Design_Package
  • Mage_Core_Model_Design_Source_Design
  • Mage_Core_Model_Email
  • Mage_Core_Model_Email_Info
  • Mage_Core_Model_Email_Template
  • Mage_Core_Model_Email_Template_Filter
  • Mage_Core_Model_Email_Template_Mailer
  • Mage_Core_Model_Email_Transport
  • Mage_Core_Model_Encryption
  • Mage_Core_Model_File_Storage
  • Mage_Core_Model_File_Storage_Abstract
  • Mage_Core_Model_File_Storage_Database
  • Mage_Core_Model_File_Storage_Database_Abstract
  • Mage_Core_Model_File_Storage_Directory_Database
  • Mage_Core_Model_File_Storage_File
  • Mage_Core_Model_File_Storage_Flag
  • Mage_Core_Model_File_Uploader
  • Mage_Core_Model_File_Validator_AvailablePath
  • Mage_Core_Model_File_Validator_NotProtectedExtension
  • Mage_Core_Model_Flag
  • Mage_Core_Model_Input_Filter
  • Mage_Core_Model_Input_Filter_MaliciousCode
  • Mage_Core_Model_Language
  • Mage_Core_Model_Layout
  • Mage_Core_Model_Layout_Data
  • Mage_Core_Model_Layout_Element
  • Mage_Core_Model_Layout_Update
  • Mage_Core_Model_Locale
  • Mage_Core_Model_Locale_Config
  • Mage_Core_Model_Log_Adapter
  • Mage_Core_Model_Magento_Api
  • Mage_Core_Model_Magento_Api_V2
  • Mage_Core_Model_Message
  • Mage_Core_Model_Message_Abstract
  • Mage_Core_Model_Message_Collection
  • Mage_Core_Model_Message_Error
  • Mage_Core_Model_Message_Notice
  • Mage_Core_Model_Message_Success
  • Mage_Core_Model_Message_Warning
  • Mage_Core_Model_Mysql4_Abstract
  • Mage_Core_Model_Mysql4_Cache
  • Mage_Core_Model_Mysql4_Collection_Abstract
  • Mage_Core_Model_Mysql4_Config
  • Mage_Core_Model_Mysql4_Config_Data
  • Mage_Core_Model_Mysql4_Config_Data_Collection
  • Mage_Core_Model_Mysql4_Design
  • Mage_Core_Model_Mysql4_Design_Collection
  • Mage_Core_Model_Mysql4_Design_Package_Collection
  • Mage_Core_Model_Mysql4_Design_Theme
  • Mage_Core_Model_Mysql4_Email_Template
  • Mage_Core_Model_Mysql4_Email_Template_Collection
  • Mage_Core_Model_Mysql4_File_Storage_Abstract
  • Mage_Core_Model_Mysql4_File_Storage_Database
  • Mage_Core_Model_Mysql4_File_Storage_Directory_Database
  • Mage_Core_Model_Mysql4_File_Storage_File
  • Mage_Core_Model_Mysql4_Flag
  • Mage_Core_Model_Mysql4_Language
  • Mage_Core_Model_Mysql4_Language_Collection
  • Mage_Core_Model_Mysql4_Layout
  • Mage_Core_Model_Mysql4_Resource
  • Mage_Core_Model_Mysql4_Session
  • Mage_Core_Model_Mysql4_Store
  • Mage_Core_Model_Mysql4_Store_Collection
  • Mage_Core_Model_Mysql4_Store_Group
  • Mage_Core_Model_Mysql4_Store_Group_Collection
  • Mage_Core_Model_Mysql4_Translate
  • Mage_Core_Model_Mysql4_Translate_String
  • Mage_Core_Model_Mysql4_Url_Rewrite
  • Mage_Core_Model_Mysql4_Url_Rewrite_Collection
  • Mage_Core_Model_Mysql4_Variable
  • Mage_Core_Model_Mysql4_Variable_Collection
  • Mage_Core_Model_Mysql4_Website
  • Mage_Core_Model_Mysql4_Website_Collection
  • Mage_Core_Model_Observer
  • Mage_Core_Model_Resource
  • Mage_Core_Model_Resource_Abstract
  • Mage_Core_Model_Resource_Cache
  • Mage_Core_Model_Resource_Config
  • Mage_Core_Model_Resource_Config_Data
  • Mage_Core_Model_Resource_Config_Data_Collection
  • Mage_Core_Model_Resource_Db_Abstract
  • Mage_Core_Model_Resource_Db_Collection_Abstract
  • Mage_Core_Model_Resource_Design
  • Mage_Core_Model_Resource_Design_Collection
  • Mage_Core_Model_Resource_Design_Package_Collection
  • Mage_Core_Model_Resource_Email_Template
  • Mage_Core_Model_Resource_Email_Template_Collection
  • Mage_Core_Model_Resource_Entity_Abstract
  • Mage_Core_Model_Resource_Entity_Table
  • Mage_Core_Model_Resource_File_Storage_Abstract
  • Mage_Core_Model_Resource_File_Storage_Database
  • Mage_Core_Model_Resource_File_Storage_Directory_Database
  • Mage_Core_Model_Resource_File_Storage_File
  • Mage_Core_Model_Resource_Flag
  • Mage_Core_Model_Resource_Helper_Abstract
  • Mage_Core_Model_Resource_Helper_Mysql4
  • Mage_Core_Model_Resource_Iterator
  • Mage_Core_Model_Resource_Language
  • Mage_Core_Model_Resource_Language_Collection
  • Mage_Core_Model_Resource_Layout
  • Mage_Core_Model_Resource_Resource
  • Mage_Core_Model_Resource_Session
  • Mage_Core_Model_Resource_Setup
  • Mage_Core_Model_Resource_Setup_Query_Modifier
  • Mage_Core_Model_Resource_Store
  • Mage_Core_Model_Resource_Store_Collection
  • Mage_Core_Model_Resource_Store_Group
  • Mage_Core_Model_Resource_Store_Group_Collection
  • Mage_Core_Model_Resource_Transaction
  • Mage_Core_Model_Resource_Translate
  • Mage_Core_Model_Resource_Translate_String
  • Mage_Core_Model_Resource_Type_Abstract
  • Mage_Core_Model_Resource_Type_Db
  • Mage_Core_Model_Resource_Type_Db_Mysqli
  • Mage_Core_Model_Resource_Type_Db_Mysqli_Setup
  • Mage_Core_Model_Resource_Type_Db_Pdo_Mysql
  • Mage_Core_Model_Resource_Url_Rewrite
  • Mage_Core_Model_Resource_Url_Rewrite_Collection
  • Mage_Core_Model_Resource_Variable
  • Mage_Core_Model_Resource_Variable_Collection
  • Mage_Core_Model_Resource_Website
  • Mage_Core_Model_Resource_Website_Collection
  • Mage_Core_Model_Session
  • Mage_Core_Model_Session_Abstract
  • Mage_Core_Model_Session_Abstract_Varien
  • Mage_Core_Model_Session_Abstract_Zend
  • Mage_Core_Model_Source_Email_Variables
  • Mage_Core_Model_Store
  • Mage_Core_Model_Store_Api
  • Mage_Core_Model_Store_Api_V2
  • Mage_Core_Model_Store_Group
  • Mage_Core_Model_Template
  • Mage_Core_Model_Translate
  • Mage_Core_Model_Translate_Expr
  • Mage_Core_Model_Translate_Inline
  • Mage_Core_Model_Translate_String
  • Mage_Core_Model_Url
  • Mage_Core_Model_Url_Rewrite
  • Mage_Core_Model_Url_Validator
  • Mage_Core_Model_Variable
  • Mage_Core_Model_Variable_Config
  • Mage_Core_Model_Variable_Observer
  • Mage_Core_Model_Website
  • Mage_Page_Block_Switch
  • Mage_Page_Block_Template_Container
  • Mage_Page_Block_Template_Links
  • Mage_Page_Block_Template_Links_Block
  • Mage_Sales_Model_Quote_Address_Total_Collector

Exceptions

  • Mage_Core_Controller_Varien_Exception
  • Mage_Core_Exception
  • Mage_Core_Model_Session_Exception
  • Mage_Core_Model_Store_Exception

Functions

  • destruct
  • is_dir_writeable
  • is_empty_date
  • mageCoreErrorHandler
  • mageDebugBacktrace
  • mageDelTree
  • mageFindClassFile
  • mageParseCsv
  • mageSendErrorFooter
  • mageSendErrorHeader
  • mageUndoMagicQuotes
  • now
  • sys_get_temp_dir
  • uc_words
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Core_Model_Input_Filter

Filter data collector

Model for multi-filtering all data which set to models Example:

/** @var $filter Mage_Core_Model_Input_Filter */
$filter = Mage::getModel('core/input_filter');
$filter->setFilters(array(
     'list_values' => array(
         'children_filters' => array( //filters will applied to all children
             array(
                 'zend' => 'StringToUpper',
                 'args' => array('encoding' => 'utf-8')),
             array('zend' => 'StripTags')
         )
     ),
     'list_values_with_name' => array(
         'children_filters' => array(
             'item1' => array(
                 array(
                     'zend' => 'StringToUpper',
                     'args' => array('encoding' => 'utf-8'))),
             'item2' => array(
                 array('model' => 'core/input_filter_maliciousCode')
             ),
             'item3' => array(
                 array(
                     'helper' => 'core',
                     'method' => 'stripTags',
                     'args' => array('<p> <div>', true))
             )
         )
     )
 ));
 $filter->addFilter('name2', new Zend_Filter_Alnum());
 $filter->addFilter('name1',
     array(
         'zend' => 'StringToUpper',
         'args' => array('encoding' => 'utf-8')));
 $filter->addFilter('name1', array('zend' => 'StripTags'), Zend_Filter::CHAIN_PREPEND);
 $filter->addFilters(protected $_filtersToAdd = array(
     'list_values_with_name' => array(
         'children_filters' => array(
             'deep_list' => array(
                 'children_filters' => array(
                     'sub1' => array(
                         array(
                             'zend' => 'StringToLower',
                             'args' => array('encoding' => 'utf-8'))),
                     'sub2' => array(array('zend' => 'Int'))
                 )
             )
         )
     )
 ));
 $filter->filter(array(
     'name1' => 'some <b>string</b>',
     'name2' => '888 555',
     'list_values' => array(
         'some <b>string2</b>',
         'some <p>string3</p>',
     ),
     'list_values_with_name' => array(
         'item1' => 'some <b onclick="alert(\'2\')">string4</b>',
        'item2' => 'some <b onclick="alert(\'1\')">string5</b>',
         'item3' => 'some <p>string5</p> <b>bold</b> <div>div</div>',
         'deep_list' => array(
             'sub1' => 'toLowString',
             'sub2' => '5 TO INT',
         )
     )
 ));
Mage_Core_Model_Input_Filter implements Zend_Filter_Interface
Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Api Team <api-team@magento.com>
See: Mage_Core_Model_Input_FilterTest See this class for manual
Located at code/core/Mage/Core/Model/Input/Filter.php
Methods summary
public Mage_Core_Model_Input_Filter
# addFilter( string $name, array|Zend_Filter_Interface $filter, string $placement = Zend_Filter::CHAIN_APPEND )

Add filter

Add filter

Parameters

$name
string
$name
$filter
array|Zend_Filter_Interface
$filter
$placement
string
$placement

Returns

Mage_Core_Model_Input_Filter
public Mage_Core_Model_Input_Filter
# appendFilter( Zend_Filter_Interface $filter )

Add a filter to the end of the chain

Add a filter to the end of the chain

Parameters

$filter
array|Zend_Filter_Interface
$filter

Returns

Mage_Core_Model_Input_Filter
public Mage_Core_Model_Input_Filter
# prependFilter( array|Zend_Filter_Interface $filter )

Add a filter to the start of the chain

Add a filter to the start of the chain

Parameters

$filter
array|Zend_Filter_Interface
$filter

Returns

Mage_Core_Model_Input_Filter
public Mage_Core_Model_Input_Filter
# addFilters( array $filters )

Add filters

Add filters

Filters data must be has view as array( 'key1' => $filters, 'key2' => array( ... ), //array filters data 'key2' => $filters )

Parameters

$filters
array
$filters

Returns

Mage_Core_Model_Input_Filter
public Mage_Core_Model_Input_Filter
# setFilters( array $filters )

Set filters

Set filters

Parameters

$filters
array
$filters

Returns

Mage_Core_Model_Input_Filter
public array
# getFilters( string|null $name = null )

Get filters

Get filters

Parameters

$name
string|null
$name Get filter for selected name

Returns

array
public array
# filter( array $data )

Filter data

Filter data

Parameters

$data
array
$data

Returns

array
Return filtered data
protected array
# _filter( array $data, array|null & $filters = null, boolean $isFilterListSimple = false )

Recursive filtering

Recursive filtering

Parameters

$data
array
$data
$filters
array|null
$filters
$isFilterListSimple
boolean
$isFilterListSimple

Returns

array

Throws

Exception
Exception when filter is not found or not instance of defined instances
protected mixed
# _applyFiltrationWithHelper( mixed $value, Mage_Core_Helper_Abstract $helper, array $filterData )

Call specified helper method for $value filtration

Call specified helper method for $value filtration

Parameters

$value
mixed
$value
$helper
Mage_Core_Helper_Abstract
$helper
$filterData
array
$filterData

Returns

mixed
protected boolean|Mage_Core_Helper_Abstract
# _getFiltrationHelper( mixed $filterData )

Try to create Magento helper for filtration based on $filterData. Return false on failure

Try to create Magento helper for filtration based on $filterData. Return false on failure

Parameters

$filterData
mixed
$filterData

Returns

boolean|Mage_Core_Helper_Abstract

Throws

Exception
protected boolean|Zend_Filter_Interface
# _getZendFilter( mixed $filterData )

Try to create Zend filter based on $filterData. Return false on failure

Try to create Zend filter based on $filterData. Return false on failure

Parameters

$filterData
mixed
$filterData

Returns

boolean|Zend_Filter_Interface
protected Zend_Filter_Interface
# _createCustomZendFilter( mixed $filterData )

Get Magento filters

Get Magento filters

Parameters

$filterData
mixed
$filterData

Returns

Zend_Filter_Interface

Throws

Exception
protected Zend_Filter_Interface
# _createNativeZendFilter( mixed $filterData )

Get native Zend_Filter

Get native Zend_Filter

Parameters

$filterData
mixed
$filterData

Returns

Zend_Filter_Interface

Throws

Exception
Properties summary
protected array $_filters array()
#

Filters data collectors

Filters data collectors

Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0