Properties

$_Solar_Filter

(array) User-defined configuration values.

$_chain_filters

(array) The chain of filters to be applied to the data array.

Format is 'data_key' => array(), where the sub-array is a sequential array of callbacks.

For example, this will filter the $data['rank'] value to validate as an integer in the range 0-9.

$this->_chain_filters = array(
    'rank' => array(
        'validateInt',
        array('validateRange', 0, 9),
    )
);

$_chain_invalid

(array) After processing, this contains the list of validation failure messages for each data key.

$_chain_locale_object

(Solar_Base) The object used for generating "invalid" messages.

Defaults to $this.

$_chain_require

(array) Tells the filter chain if a particular data key is required.

The key is the data key name, the value is a boolean (true if required, false if not).

$_chain_whitelist

(array) Tells the filter chain which data keys to filter.

If the whitelist is empty, filter all data keys.

$_config

(array) Collection point for configuration values.

Inherited from Solar_Base.

Note that you do not define config defaults in $_config directly.

<?php
// DO NOT DO THIS
protected $_config = array(
    'foo' => 'bar',
    'baz' => 'dib',
);

Instead, define config defaults in a protected property named for the class, withan underscore prefix.

For exmple, a "Vendor_Class_Name" class would define the default config array in "$_Vendor_Class_Name". This convention lets child classes inherit parent config keys and values.

<?php
// DO THIS INSTEAD
protected $_Vendor_Class_Name = array(
    'foo' => 'bar',
    'baz' => 'dib',
);

$_data

(array) The data array to be filtered by the chain.

$_data_key

(string) The name of the data key currently being processed.

$_filter

(array) Filter objects, keyed on method name.

For example, 'sanitizeTrim' => Solar_Filter_Sanitize_Trim object.

$_require

(bool) Are values required to be not-blank?

For validate methods, when $_require is true, the value must be non-blank for it to validate; when false, blank values are considered valid.

For sanitize methods, when $_require is true, the method will attempt to sanitize blank values; when false, the method will return blank values as nulls.

$_stack

(Solar_Class_Stack) Class stack for finding filters.