Site

Type

Class

Namespace

craft\models

Inherits

craft\models\Site » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

3.0.0

Site model class.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
baseUrl	string, null – The site’s base URL
behaviors	yii\base\Behavior – List of behaviors attached to this component.
config	array
dateCreated	DateTime – Date created
dateUpdated	DateTime – Date updated
enabled	boolean – Enabled?
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
group	craft\models\SiteGroup
groupId	integer, null – Group ID
handle	string, null – Handle
hasUrls	boolean – Has URLs
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
language	string, null – Name
locale	craft\i18n\Locale
name	string – The site’s name
originalBaseUrl	string, null – Original base URL (set if baseUrl was overridden by the config)
originalName	string, null – Original name (set if name was overridden by the config)
primary	boolean – Primary site?
scenario	string – The scenario that this model is in.
sortOrder	integer – Sort order
uid	string, null – Site UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

baseUrl

Type

string, null

Default value

null

The site’s base URL

View source

config

Type

array

Default value

null

Access

Read-only

Since

3.5.0

View source

dateCreated

Type

DateTime

Default value

null

Date created

View source

dateUpdated

Type

DateTime

Default value

null

Date updated

View source

enabled

Type

boolean

Default value

true

Since

3.5.0

Enabled?

View source

group

Type

craft\models\SiteGroup

Default value

null

Access

Read-only

View source

groupId

Type

integer, null

Default value

null

Group ID

View source

handle

Type

string, null

Default value

null

Handle

View source

hasUrls

Type

boolean

Default value

true

Has URLs

View source

id

Type

integer, null

Default value

null

ID

View source

language

Type

string, null

Default value

null

Name

View source

locale

Type

craft\i18n\Locale

Default value

null

Access

Read-only

Since

3.5.8

View source

name

Type

string

Default value

null

The site’s name

View source

originalBaseUrl

DEPRECATED

Deprecated in 3.6.0

Type

string, null

Default value

null

Original base URL (set if baseUrl was overridden by the config)

View source

originalName

DEPRECATED

Deprecated in 3.6.0

Type

string, null

Default value

null

Original name (set if name was overridden by the config)

View source

primary

Type

boolean

Default value

false

Primary site?

View source

sortOrder

Type

integer

Default value

1

Sort order

View source

uid

Type

string, null

Default value

null

Site UID

View source

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()	Use the translated group name as the string representation.
__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.
getBaseUrl()	Returns the site’s base URL.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getConfig()	Returns the site’s config.
getError()	Returns the first error of the specified attribute.
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.
getGroup()	Returns the site's group
getIterator()	Returns an iterator for traversing the attributes in the model.
getLocale()	Returns the locale for this site’s language.
getName()	Returns the site’s name.
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.
overrideBaseUrl()	Overrides the base URL while keeping track of the original one.
overrideName()	Overrides the name while keeping track of the original one.
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.
setAttributes()	Sets the attribute values in a massive way.
setBaseUrl()	Sets the site’s base URL.
setName()	Sets the site’s name.
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.

__toString()

Use the translated group name as the string representation.

View source

Returns

string

attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source

Returns

array – Attribute labels (name => label)

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.

View source

Returns

string[] – List of attribute names.

behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\models\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source

Returns

array – The behavior configurations.

getBaseUrl()

Since

3.1.0

Returns the site’s base URL.

View source

Arguments

• $parse (boolean) – Whether to parse the name for an alias or environment variable

Returns

string, null

getConfig()

Since

3.5.0

Returns the site’s config.

View source

Returns

array

getGroup()

Returns the site's group

View source

Returns

craft\models\SiteGroup

Throws

• yii\base\InvalidConfigException
  if groupId is missing or invalid

getLocale()

Since

3.5.8

Returns the locale for this site’s language.

View source

Returns

craft\i18n\Locale

getName()

Since

3.6.0

Returns the site’s name.

View source

Arguments

• $parse (boolean) – Whether to parse the name for an environment variable

Returns

string

init()

Since

3.5.0

Initializes the object.

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

View source

overrideBaseUrl()

DEPRECATED

Deprecated in 3.6.0

Overrides the base URL while keeping track of the original one.

View source

Arguments

• $baseUrl (string)

overrideName()

DEPRECATED

Deprecated in 3.6.0

Overrides the name while keeping track of the original one.

View source

Arguments

• $name (string)

setBaseUrl()

Since

3.6.0

Sets the site’s base URL.

View source

Arguments

• $baseUrl (string, null)

setName()

Since

3.6.0

Sets the site’s name.

View source

Arguments

• $name (string)

Protected Methods

Method	Description
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().

defineRules()

Since

3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.