Class craft\validators\AssetLocationValidator

Inheritance: craft\validators\AssetLocationValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/validators/AssetLocationValidator.php

Class AssetLocationValidator.

Public Properties
Property	Type	Description	Defined By
`$allowedExtensions`	string[], null	Allowed file extensions	craft\validators\AssetLocationValidator
`$attributes`	array, string	Attributes to be validated by this validator.	yii\validators\Validator
`$avoidFilenameConflicts`	boolean	Whether Asset should avoid filename conflicts when saved.	craft\validators\AssetLocationValidator
`$builtInValidators`	array	List of built-in validators (name => class or configuration)	yii\validators\Validator
`$conflictingFilenameAttribute`	string	The conflicting filename attribute on the model	craft\validators\AssetLocationValidator
`$disallowedExtension`	string, null	User-defined error message used when the extension is disallowed.	craft\validators\AssetLocationValidator
`$enableClientValidation`	boolean	Whether to enable client-side validation for this validator.	yii\validators\Validator
`$errorCodeAttribute`	string	The error code attribute on the model	craft\validators\AssetLocationValidator
`$except`	array, string	Scenarios that the validator should not be applied to.	yii\validators\Validator
`$filenameAttribute`	string	The filename attribute on the model	craft\validators\AssetLocationValidator
`$filenameConflict`	string, null	User-defined error message used when a file already exists with the same name.	craft\validators\AssetLocationValidator
`$folderIdAttribute`	string	The folder ID attribute on the model	craft\validators\AssetLocationValidator
`$isEmpty`	callable	A PHP callable that replaces the default implementation of isEmpty().	yii\validators\Validator
`$message`	string	The user-defined error message.	yii\validators\Validator
`$on`	array, string	Scenarios that the validator can be applied to.	yii\validators\Validator
`$skipOnEmpty`	boolean	Whether this validation rule should be skipped if the attribute value is null or an empty string.	yii\validators\Validator
`$skipOnError`	boolean	Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules.	yii\validators\Validator
`$suggestedFilenameAttribute`	string	The suggested filename attribute on the model	craft\validators\AssetLocationValidator
`$when`	callable	A PHP callable whose return value determines whether this validator should be applied.	yii\validators\Validator
`$whenClient`	string	A JavaScript function name whose return value determines whether this validator should be applied on the client-side.	yii\validators\Validator

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

Protected Methods
Method	Description	Defined By
`formatMessage()`	Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.	yii\validators\Validator
`validateValue()`	Validates a value.	yii\validators\Validator

Property Details

`$allowedExtensions` public property #

Allowed file extensions

public string[], null $allowedExtensions = null

`$avoidFilenameConflicts` public property #

Whether Asset should avoid filename conflicts when saved.

public boolean $avoidFilenameConflicts = null

`$conflictingFilenameAttribute` public property #

The conflicting filename attribute on the model

public string $conflictingFilenameAttribute = 'conflictingFilename'

`$disallowedExtension` public property #

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

public string, null $disallowedExtension = null

`$errorCodeAttribute` public property #

The error code attribute on the model

public string $errorCodeAttribute = 'locationError'

`$filenameAttribute` public property #

The filename attribute on the model

public string $filenameAttribute = 'filename'

`$filenameConflict` public property #

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

public string, null $filenameConflict = null

`$folderIdAttribute` public property #

The folder ID attribute on the model

public string $folderIdAttribute = 'folderId'

`$suggestedFilenameAttribute` public property #

The suggested filename attribute on the model

public string $suggestedFilenameAttribute = 'suggestedFilename'

Method Details

`addLocationError()` public method #

Adds a location error to the model.

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

`$model`	yii\base\Model
`$attribute`	string
`$errorCode`	string
`$message`	string
`$params`	array

`init()` public method #

{@inheritdoc}

public void init ( )

`validateAttribute()` public method #

Validates a single attribute.

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

public void validateAttribute ( $model, $attribute )

`$model`	yii\base\Model	The data model to be validated
`$attribute`	string	The name of the attribute to be validated.

Property Details

$allowedExtensions public property #

$avoidFilenameConflicts public property #

$conflictingFilenameAttribute public property #

$disallowedExtension public property #

$errorCodeAttribute public property #

$filenameAttribute public property #

$filenameConflict public property #

$folderIdAttribute public property #

$suggestedFilenameAttribute public property #