Zend_Validate_Callback Class Reference

Inheritance diagram for Zend_Validate_Callback:

Public Member Functions
	__construct ($callback=null)
	getCallback ()
	setCallback ($callback)
	getOptions ()
	setOptions ($options)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()

Data Fields
const	INVALID_CALLBACK = 'callbackInvalid'
const	INVALID_VALUE = 'callbackValue'

Protected Attributes
	$_messageTemplates
	$_callback = null
	$_options = array()
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 33 of file Callback.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$callback = null

)

Sets validator options

Parameters

mixed

$callback

Exceptions

Zend_Validate_Exception

Definition at line 75 of file Callback.php.

    {
        if (is_callable($callback)) {
            $this->setCallback($callback);
        } elseif (is_array($callback)) {
            if (isset($callback['callback'])) {
                $this->setCallback($callback['callback']);
            }
            if (isset($callback['options'])) {
                $this->setOptions($callback['options']);
            }
        }

        if (null === ($initializedCallack = $this->getCallback())) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('No callback registered');
        }
    }

Member Function Documentation

getCallback()

getCallback

(

)

Returns the set callback

Returns

mixed

Definition at line 99 of file Callback.php.

    {
        return $this->_callback;
    }

getOptions()

getOptions

(

)

Returns the set options for the callback

Returns

mixed

Definition at line 126 of file Callback.php.

    {
        return $this->_options;
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

Returns true if and only if the set callback returns for the provided $value

Parameters

mixed

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 152 of file Callback.php.

    {
        $this->_setValue($value);

        $options  = $this->getOptions();
        $callback = $this->getCallback();
        $args     = func_get_args();
        $options  = array_merge($args, $options);

        try {
            if (!call_user_func_array($callback, $options)) {
                $this->_error(self::INVALID_VALUE);
                return false;
            }
        } catch (Exception $e) {
            $this->_error(self::INVALID_CALLBACK);
            return false;
        }

        return true;
    }

setCallback()

setCallback

(

$callback

)

Sets the callback

Parameters

string | array

$callback

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_Callback Provides a fluent interface

Definition at line 111 of file Callback.php.

    {
        if (!is_callable($callback)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Invalid callback given');
        }
        $this->_callback = $callback;
        return $this;
    }

setOptions()

setOptions

(

$options

)

Sets options for the callback

Parameters

mixed

$options

Returns

Zend_Validate_Callback Provides a fluent interface

Definition at line 137 of file Callback.php.

    {
        $this->_options = (array) $options;
        return $this;
    }

Field Documentation

$_callback

$_callback = null

protected

Definition at line 60 of file Callback.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID_VALUE    => "'%value%' is not valid",
        self::INVALID_CALLBACK => "An exception has been raised within the callback",
    )

Definition at line 50 of file Callback.php.

$_options

$_options = array()

protected

Definition at line 67 of file Callback.php.

INVALID_CALLBACK

const INVALID_CALLBACK = 'callbackInvalid'

Invalid callback

Definition at line 38 of file Callback.php.

INVALID_VALUE

const INVALID_VALUE = 'callbackValue'

Invalid value

Definition at line 43 of file Callback.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Validate/Callback.php