Viewing file:  Callback.php (10.32 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* Rule checking the value via a callback function (method)
*
* PHP version 5
*
* LICENSE:
*
* Copyright (c) 2006-2014, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category HTML
* @package HTML_QuickForm2
* @author Alexey Borzov <avb@php.net>
* @author Bertrand Mansion <golgote@mamasam.com>
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @link http://pear.php.net/package/HTML_QuickForm2
*/
/**
* Base class for HTML_QuickForm2 rules
*/
require_once 'HTML/QuickForm2/Rule.php';
/**
* Rule checking the value via a callback function (method)
*
* The Rule needs a valid callback as a configuration parameter for its work, it
* may also be given additional arguments to pass to the callback alongside the
* element's value. See {@link mergeConfig()} for description of possible ways
* to pass configuration parameters.
*
* The callback will be called with element's value as the first argument, if
* additional arguments were provided they'll be passed as well. It is expected
* to return false if the value is invalid and true if it is valid.
*
* Checking that the value is not empty:
* <code>
* $str->addRule('callback', 'The field should not be empty', 'strlen');
* </code>
* Checking that the value is in the given array:
* <code>
* $meta->addRule('callback', 'Unknown variable name',
* array('callback' => 'in_array',
* 'arguments' => array(array('foo', 'bar', 'baz'))));
* </code>
* The same, but with rule registering first:
* <code>
* HTML_QuickForm2_Factory::registerRule(
* 'in_array', 'HTML_QuickForm2_Rule_Callback',
* 'HTML/QuickForm2/Rule/Callback.php', 'in_array'
* );
* $meta->addRule('in_array', 'Unknown variable name', array(array('foo', 'bar', 'baz')));
* </code>
*
* @category HTML
* @package HTML_QuickForm2
* @author Alexey Borzov <avb@php.net>
* @author Bertrand Mansion <golgote@mamasam.com>
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @version Release: 2.0.2
* @link http://pear.php.net/package/HTML_QuickForm2
*/
class HTML_QuickForm2_Rule_Callback extends HTML_QuickForm2_Rule
{
/**
* Validates the owner element
*
* @return bool the value returned by a callback function
*/
protected function validateOwner()
{
$value = $this->owner->getValue();
$config = $this->getConfig();
return (bool)call_user_func_array(
$config['callback'], array_merge(array($value), $config['arguments'])
);
}
protected function getJavascriptCallback()
{
HTML_QuickForm2_Loader::loadClass('HTML_QuickForm2_JavascriptBuilder');
$config = $this->getConfig();
$arguments = array($this->owner->getJavascriptValue());
foreach ($config['arguments'] as $arg) {
$arguments[] = HTML_QuickForm2_JavascriptBuilder::encode($arg);
}
return "function() { return " . $this->findJavascriptName() .
"(" . implode(', ', $arguments) . "); }";
}
/**
* Finds a name for Javascript callback function
*
* The method first checks whether javascript callback 'js_callback' was
* provided to the Rule and returns that if found.
*
* If an explicit 'js_callback' was not provided, it tries to generate a name
* equal (for a given value of "equal") to PHP callback name. This may be useful
* if e.g. using HTML_AJAX package to generate class stubs in JS and in similar
* circumstances.
*
* If a callback does not have a name (it is a lambda function or a closure)
* then an exception will be raised.
*
* @return string
*/
protected function findJavascriptName()
{
$config = $this->getConfig();
// oh joy! we have an explicitly given JS callback!
if (isset($config['js_callback'])) {
return $config['js_callback'];
}
// no luck, try to come up with a name similar to PHP one
// function name, filter lambdas created via create_function...
if (is_string($config['callback']) && chr(0) != $config['callback'][0]) {
return str_replace('::', '.', $config['callback']);
// object instance method
} elseif (is_array($config['callback']) && is_object($config['callback'][0])) {
return '(new ' . get_class($config['callback'][0]) . ').' . $config['callback'][1];
// static class method
} elseif (is_array($config['callback']) && is_string($config['callback'][0])) {
return $config['callback'][0] . '.' . $config['callback'][1];
// lambda, closure, whatever: no sane way to translate
} else {
throw new HTML_QuickForm2_InvalidArgumentException(
"Cannot generate Javascript callback name, please provide one"
);
}
}
/**
* Tests whether a given value is an array containing at least one of the given keys
*
* @param mixed $search if not an array, method will return false
* @param array $keys keys to test for
*
* @return bool
*/
protected static function arrayHasSomeKeys($search, array $keys)
{
if (is_array($search)) {
foreach ($keys as $key) {
if (array_key_exists($key, $search)) {
return true;
}
}
}
return false;
}
/**
* Merges local configuration with that provided for registerRule()
*
* "Global" configuration may be passed to
* {@link HTML_QuickForm2_Factory::registerRule()} in either of the
* following formats
* - callback
* - array(['callback' => callback][, 'arguments' => array(...)][, 'js_callback' => string])
*
* "Local" configuration may be passed to the constructor in either of
* the following formats
* - callback or arguments (interpretation depends on whether the global
* configuration already contains the callback)
* - array(['callback' => callback][, 'arguments' => array(...)][, 'js_callback' => string])
*
* As usual, global config overrides local one. It is a good idea to use the
* associative array format to prevent ambiguity.
*
* @param mixed $localConfig Local configuration
* @param mixed $globalConfig Global configuration
*
* @return mixed Merged configuration
*/
public static function mergeConfig($localConfig, $globalConfig)
{
if (!isset($globalConfig)) {
$config = $localConfig;
} else {
if (!self::arrayHasSomeKeys($globalConfig, array('callback', 'arguments', 'js_callback'))) {
$config = array('callback' => $globalConfig);
} else {
$config = $globalConfig;
}
if (self::arrayHasSomeKeys($localConfig, array('callback', 'arguments', 'js_callback'))) {
$config += $localConfig;
} elseif (isset($localConfig)) {
$config += array('callback' => $localConfig, 'arguments' => $localConfig);
}
}
return $config;
}
/**
* Sets the callback to use for validation and its additional arguments
*
* @param callback|array $config Callback or array ('callback' => validation callback
* [, 'arguments' => additional arguments]
* [, 'js_callback' => javascript callback
* for client-side validation])
*
* @return HTML_QuickForm2_Rule
* @throws HTML_QuickForm2_InvalidArgumentException if callback is missing or invalid
* or additional arguments is not an array
*/
public function setConfig($config)
{
if (!is_array($config) || !isset($config['callback'])) {
$config = array('callback' => $config);
}
if (!is_callable($config['callback'], false, $callbackName)) {
throw new HTML_QuickForm2_InvalidArgumentException(
'Callback Rule requires a valid callback, \'' . $callbackName .
'\' was given'
);
}
if (array_key_exists('arguments', $config) && !is_array($config['arguments'])) {
throw new HTML_QuickForm2_InvalidArgumentException(
'Callback Rule expects additional callback arguments to be an array, ' .
preg_replace('/\s+/', ' ', var_export($config['arguments'], true)) . ' given'
);
}
return parent::setConfig($config + array('arguments' => array()));
}
}
?>
|