NewSiblingBefore

Type

Class

Namespace

craft\elements\actions

Inherits

craft\elements\actions\NewSiblingBefore » craft\base\ElementAction » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\ElementActionInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)

Since

3.7.0

NewSibling represents a “Create a new X before” element action.

View source (opens new window)

Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
confirmationMessage	string (opens new window), null (opens new window) – The confirmation message, if any.
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window)	array (opens new window) – The first errors.
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
label	string (opens new window), null (opens new window) – The trigger label
message	string (opens new window), null (opens new window) – The message that should be displayed to the user.
newSiblingUrl	string (opens new window), null (opens new window) – The URL that the user should be taken to after clicking on this element action
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
settings	array (opens new window) – The component’s settings.
settingsHtml	string (opens new window), null (opens new window)
triggerHtml	string (opens new window), null (opens new window) – The action’s trigger HTML.
triggerLabel	string (opens new window) – The action’s trigger label
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

label

Type

string (opens new window), null (opens new window)

Default value

null

The trigger label

View source (opens new window)

newSiblingUrl

Type

string (opens new window), null (opens new window)

Default value

null

The URL that the user should be taken to after clicking on this element action

View source (opens new window)

triggerHtml

Type

string (opens new window), null (opens new window)

Default value

null

Access

Read-only

The action’s trigger HTML.

View source (opens new window)

triggerLabel

Type

string (opens new window)

Default value

null

Access

Read-only

The action’s trigger label

View source (opens new window)

Protected Properties

Property	Description
elementType	string (opens new window), craft\base\ElementInterface

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone()
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels() (opens new window)	Returns the attribute labels.
attributes() (opens new window)	Returns the list of attribute names.
beforeValidate() (opens new window)	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes()	Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
displayName()	Returns the display name of this class.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window)	Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window)	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName()