AssetLocationValidator

Type
Class
Namespace
craft\validators
Inherits
craft\validators\AssetLocationValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

Class AssetLocationValidator.

View source

Public Properties

PropertyDescription
$allowedExtensionsstring[], null – Allowed file extensions
$attributeNamesarray – Attribute names.
$attributesarray, string – Attributes to be validated by this validator.
$avoidFilenameConflictsboolean – Whether Asset should avoid filename conflicts when saved.
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$builtInValidatorsarray – List of built-in validators (name => class or configuration)
$conflictingFilenameAttributestring – The conflicting filename attribute on the model
$disallowedExtensionstring, null – User-defined error message used when the extension is disallowed.
$enableClientValidationboolean – Whether to enable client-side validation for this validator.
$errorCodeAttributestring – The error code attribute on the model
$exceptarray, string – Scenarios that the validator should not be applied to.
$filenameAttributestring – The filename attribute on the model
$filenameConflictstring, null – User-defined error message used when a file already exists with the same name.
$folderIdAttributestring – The folder ID attribute on the model
$isEmptycallable – A PHP callable that replaces the default implementation of isEmpty().
$messagestring – The user-defined error message.
$onarray, string – Scenarios that the validator can be applied to.
$skipOnEmptyboolean – Whether this validation rule should be skipped if the attribute value is null or an empty string.
$skipOnErrorboolean – Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules.
$suggestedFilenameAttributestring – The suggested filename attribute on the model
$whencallable – A PHP callable whose return value determines whether this validator should be applied.
$whenClientstring – A JavaScript function name whose return value determines whether this validator should be applied on the client-side.

$allowedExtensions

Type
string[], null

Allowed file extensions

View source

Signature

public string[], null $allowedExtensions = null

$avoidFilenameConflicts

Type
boolean

Whether Asset should avoid filename conflicts when saved.

View source

Signature

public boolean $avoidFilenameConflicts = null

$conflictingFilenameAttribute

Type
string

The conflicting filename attribute on the model

View source

Signature

public string $conflictingFilenameAttribute = 'conflictingFilename'

$disallowedExtension

Type
string, null

User-defined error message used when the extension is disallowed.

View source

Signature

public string, null $disallowedExtension = null

$errorCodeAttribute

Type
string

The error code attribute on the model

View source

Signature

public string $errorCodeAttribute = 'locationError'

$filenameAttribute

Type
string

The filename attribute on the model

View source

Signature

public string $filenameAttribute = 'filename'

$filenameConflict

Type
string, null

User-defined error message used when a file already exists with the same name.

View source

Signature

public string, null $filenameConflict = null

$folderIdAttribute

Type
string

The folder ID attribute on the model

View source

Signature

public string $folderIdAttribute = 'folderId'

$suggestedFilenameAttribute

Type
string

The suggested filename attribute on the model

View source

Signature

public string $suggestedFilenameAttribute = 'suggestedFilename'

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
addError()Adds an error about the specified attribute to the model object.
addLocationError()Adds a location error to the model.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clientValidateAttribute()Returns the JavaScript needed for performing client-side validation.
createValidator()Creates a validator object.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getAttributeNames()Returns cleaned attribute names without the ! character at the beginning.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getClientOptions()Returns the client-side validation options.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
isActive()Returns a value indicating whether the validator is active for the given scenario and attribute.
isEmpty()Checks if the given value is empty.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
trigger()Triggers an event.
validate()Validates a given value.
validateAttribute()Validates a single attribute.
validateAttributes()Validates the specified object.

addLocationError()

Adds a location error to the model.

View source

Arguments

Signature

public void addLocationError ( yii\base\Model $model, \craft\validators\string $attribute, \craft\validators\string $errorCode, \craft\validators\string $message, array $params = [] )

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Signature

public void init ( )

validateAttribute()

Validates a single attribute.

Child classes must implement this method to provide the actual validation logic.

View source

Arguments

  • $model (yii\base\Model) – The data model to be validated
  • $attribute (string) – The name of the attribute to be validated.

Signature

public void validateAttribute ( $model, $attribute )

Protected Methods

MethodDescription
formatMessage()Formats a mesage using the I18N, or simple strtr if \Yii::$app is not available.
validateValue()Validates a value.