LocaleValidator

Type
Class
Namespace
Craft
Inherits
Craft\LocaleValidator » CValidator (opens new window) » CComponent (opens new window)
Since
1.0

Will validate that the given attribute is a valid site locale ID.

See also http://craftcms.com

View source (opens new window)

# Public Properties

Property Description
$attributes (opens new window) array (opens new window) – List of attributes to be validated.
$builtInValidators (opens new window) array (opens new window) – List of built-in validators (name=>class)
$enableClientValidation (opens new window) boolean (opens new window) – Whether to perform client-side validation.
$except (opens new window) array (opens new window) – List of scenarios that the validator should not be applied to.
$message (opens new window) string (opens new window) – The user-defined error message.
$on (opens new window) array (opens new window) – List of scenarios that the validator should be applied.
$safe (opens new window) boolean (opens new window) – Whether attributes listed with this validator should be considered safe for massive assignment.
$skipOnError (opens new window) boolean (opens new window) – Whether this validation rule should be skipped when there is already a validation error for the current attribute.

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__get() (opens new window) Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) Sets value of a component property.
__unset() (opens new window) Sets a component property to be null.
applyTo() (opens new window) Returns a value indicating whether the validator applies to the specified scenario.
asa() (opens new window) Returns the named behavior object.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attachEventHandler() (opens new window) Attaches an event handler to an event.
canGetProperty() (opens new window) Determines whether a property can be read.
canSetProperty() (opens new window) Determines whether a property can be set.
clientValidateAttribute() (opens new window) Returns the JavaScript needed for performing client-side validation.
createValidator() (opens new window) Creates a validator object.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
detachEventHandler() (opens new window) Detaches an existing event handler.
disableBehavior() (opens new window) Disables an attached behavior.
disableBehaviors() (opens new window) Disables all behaviors attached to this component.
enableBehavior() (opens new window) Enables an attached behavior.
enableBehaviors() (opens new window) Enables all behaviors attached to this component.
evaluateExpression() (opens new window) Evaluates a PHP expression or callback under the context of this component.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
hasEvent() (opens new window) Determines whether an event is defined.
hasEventHandler() (opens new window) Checks whether the named event has attached handlers.
hasProperty() (opens new window) Determines whether a property is defined.
raiseEvent() (opens new window) Raises an event.
validate() (opens new window) Validates the specified object.

# Protected Methods

Method Description
addError() (opens new window) Adds an error about the specified attribute to the active record.
isEmpty() (opens new window) Checks if the given value is empty.
validateAttribute()

# validateAttribute()

View source (opens new window)

Arguments

  • $object
  • $attribute

Returns

null (opens new window)

Signature

protected null validateAttribute ( $object, $attribute )