ColorData ​
- Type
- Class
- Namespace
- craft\fields\data
- Inherits
- craft\fields\data\ColorData » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, craft\base\ModelInterface, craft\base\Serializable, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
- Uses traits
- craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Since
- 3.0.0
Multi-select option field data class.
Public Properties ​
Property | Description |
---|---|
activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
attributes | array – Attribute values (name => value). |
b | integer |
behaviors | yii\base\Behavior – List of behaviors attached to this component. |
blue | integer |
errors | array – Errors for all attributes or the specified attribute. |
firstErrors | array – The first errors. |
g | integer |
green | integer |
h | integer |
hex | string |
hsl | string |
hue | integer |
iterator | ArrayIterator – An iterator for traversing the items in the list. |
l | integer |
lightness | integer |
luma | float |
r | integer |
red | integer |
rgb | string |
s | integer |
saturation | integer |
scenario | string – The scenario that this model is in. |
validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
b
​
- Type
- integer
- Default value
null
blue
​
- Type
- integer
- Default value
null
g
​
- Type
- integer
- Default value
null
green
​
- Type
- integer
- Default value
null
h
​
- Type
- integer
- Default value
null
- Access
- Read-only
- Since
- 3.7.26
hex
​
- Type
- string
- Default value
null
hsl
​
- Type
- string
- Default value
null
- Access
- Read-only
- Since
- 3.7.26
hue
​
- Type
- integer
- Default value
null
- Access
- Read-only
- Since
- 3.7.26
l
​
- Type
- integer
- Default value
null
- Access
- Read-only
- Since
- 3.7.26
lightness
​
- Type
- integer
- Default value
null
- Access
- Read-only
- Since
- 3.7.26
luma
​
- Type
- float
- Default value
null
r
​
- Type
- integer
- Default value
null
red
​
- Type
- integer
- Default value
null
rgb
​
- Type
- string
- Default value
null
s
​
- Type
- integer
- Default value
null
- Access
- Read-only
- Since
- 3.7.26
saturation
​
- Type
- integer
- Default value
null
- Access
- Read-only
- Since
- 3.7.26
Public Methods ​
Method | Description |
---|---|
__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 a component property. |
__isset() | Checks if a property is set, i.e. defined and not null. |
__set() | Sets the value of a component property. |
__toString() | |
__unset() | Sets a component property to be null. |
activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. |
addError() | Adds a new error to the specified attribute. |
addErrors() | Adds a list of errors. |
addModelErrors() | Adds errors from another model, with a given attribute name prefix. |
afterValidate() | This method is invoked after validation ends. |
attachBehavior() | Attaches a behavior to this component. |
attachBehaviors() | Attaches a list of behaviors to the component. |
attributeHints() | Returns the attribute hints. |
attributeLabels() | Returns the attribute labels. |
attributes() | Returns the list of attribute names. |
beforeValidate() | This method is invoked before validation starts. |
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. |
clearErrors() | Removes errors for all attributes or a single attribute. |
createValidators() | Creates validator objects based on the validation rules specified in rules(). |
datetimeAttributes() | Returns the names of any attributes that should hold DateTime values. |
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. |
extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
formName() | Returns the form name that this model class should use. |
generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. |
getActiveValidators() | Returns the validators applicable to the current scenario. |
getAttributeHint() | Returns the text hint for the specified attribute. |
getAttributeLabel() | Returns the text label for the specified attribute. |
getAttributes() | Returns attribute values. |
getB() | |
getBehavior() | Returns the named behavior object. |
getBehaviors() | Returns all behaviors attached to this component. |
getBlue() | |
getErrorSummary() | Returns the errors for all attributes as a one-dimensional array. |
getErrors() | Returns the errors for all attributes or a single attribute. |
getFirstError() | Returns the first error of the specified attribute. |
getFirstErrors() | Returns the first error of every attribute in the model. |
getG() | |
getGreen() | |
getH() | |
getHex() | Returns the color as a hex. |
getHsl() | Returns the color in hsl() syntax. |
getHue() | |
getIterator() | Returns an iterator for traversing the attributes in the model. |
getL() | |
getLightness() | |
getLuma() | Get brightness of an image. Values closer to 0 are darker, closer to 1 are lighter. |
getR() | |
getRed() | |
getRgb() | Returns the color in rgb() syntax. |
getS() | |
getSaturation() | |
getScenario() | Returns the scenario that this model is used in. |
getValidators() | Returns all the validators declared in rules(). |
hasErrors() | Returns a value indicating whether there is any validation error. |
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 for this component. |
init() | Initializes the object. |
instance() | Returns static class instance, which can be used to obtain meta information. |
isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. |
isAttributeRequired() | Returns a value indicating whether the attribute is required. |
isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. |
load() | Populates the model with input data. |
loadMultiple() | Populates a set of models with the data from end user. |
off() | Detaches an existing event handler from this component. |
offsetExists() | Returns whether there is an element at the specified offset. |
offsetGet() | Returns the element at the specified offset. |
offsetSet() | Sets the element at the specified offset. |
offsetUnset() | Sets the element value at the specified offset to null. |
on() | Attaches an event handler to an event. |
onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. |
rules() | Returns the validation rules for attributes. |
safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. |
scenarios() | Returns a list of scenarios and the corresponding active attributes. |
serialize() | Returns the object’s serialized value. |
setAttributes() | Sets the attribute values in a massive way. |
setScenario() | Sets the scenario for the model. |
toArray() | Converts the model into an array. |
trigger() | Triggers an event. |
validate() | Performs the data validation. |
validateMultiple() | Validates multiple models. |
__construct()
​
Constructor.
Arguments ​
$hex
(string) – Hex color value, beginning with#
. (Shorthand is not supported, e.g.#f00
.)$config
(array) – Name-value pairs that will be used to initialize the object properties
__toString()
​
Returns ​
attributes()
​
Returns the list of attribute names.
By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.
Returns ​
string[] – List of attribute names.
getB()
​
Returns ​
getBlue()
​
Returns ​
getG()
​
Returns ​
getGreen()
​
Returns ​
getH()
​
- Since
- 3.7.26
Returns ​
getHex()
​
Returns the color as a hex.
Returns ​
getHsl()
​
- Since
- 3.7.26
Returns the color in hsl()
syntax.
Returns ​
getHue()
​
- Since
- 3.7.26
Returns ​
getL()
​
- Since
- 3.7.26
Returns ​
getLightness()
​
- Since
- 3.7.26
Returns ​
getLuma()
​
Get brightness of an image. Values closer to 0 are darker, closer to 1 are lighter.
See also:
- http://stackoverflow.com/a/12228906/1136822 – Stack Overflow answer
- https://en.wikipedia.org/wiki/Luma_(video) – Luma
Returns ​
getR()
​
Returns ​
getRed()
​
Returns ​
getRgb()
​
Returns the color in rgb()
syntax.
Returns ​
getS()
​
- Since
- 3.7.26
Returns ​
getSaturation()
​
- Since
- 3.7.26
Returns ​
serialize()
​
Returns the object’s serialized value.
Returns ​
mixed
– The serialized value
Protected Methods ​
Method | Description |
---|---|
defineBehaviors() | Returns the behaviors to attach to this class. |
defineRules() | Returns the validation rules for attributes. |
extractFieldsFor() | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". |
extractRootFields() | Extracts the root field names from nested fields. |
resolveFields() | Determines which fields can be returned by toArray(). |
Constants ​
Constant | Description |
---|---|
SCENARIO_DEFAULT | The name of the default scenario. |