__construct()
getMessage()
getName()
setMessage()
validate()
_init()
_isNoUserValue()
$_message
$_name
Checks if value is given
| category | Formagic |
|---|---|
| package | Rule |
| author | Florian Sonnenburg |
| copyright | Copyright (c) 2007-2009 Florian Sonnenburg |
| license | New BSD License |
| version | $Id: Mandatory.php 164 2012-04-22 20:43:38Z meweasle $ |
__construct(array $arguments)
The default error message that is displayed if the rule is violated can be overwritten by $errorMessage.
| see | \self::_init() |
|---|---|
| inherited_from | \Formagic_Rule_Abstract::__construct() |
arrayThe rule options.
getMessage() : string
| inherited_from | \Formagic_Rule_Abstract::getMessage() |
|---|
stringMessage stringgetName() : string
| inherited_from | \Formagic_Rule_Abstract::getName() |
|---|
stringThe rule namesetMessage(mixed $message) : \Formagic_Rule_Abstract
Usually a rule will have one error message string that is used if the validation fails. If neccessary, Formagic_Rule_Abstract::_errorMessage can hold other variables, eg. an array of error messages for different outcomes of the validation process.
Implements a fluent interface pattern.
| see | \Formagic_Rule_Abstract::__construct() |
|---|---|
| inherited_from | \Formagic_Rule_Abstract::setMessage() |
mixedThe error message value.
\Formagic_Rule_Abstract$this object.validate(string $value) : boolean
Mandatory rule checks if value is given.
stringItem value to be checked
booleanTrue if the item has a value_init(array $arguments) : void
| inherited_from | \Formagic_Rule_Abstract::_init() |
|---|
arrayArray of arguments passed to __construct()
_isNoUserValue(\$value $value) : boolean
The value 0 (zero) for example could be something the user entered willingly and would be skipped from rule checks when using empty().
| inherited_from | \Formagic_Rule_Abstract::_isNoUserValue() |
|---|
\$valuemixed Value to be checked
boolean$_name : string
| inherited_from | \Formagic_Rule_Abstract::$$_name |
|---|