Rule

Rule represents a business constraint that may be associated with a role, permission or assignment.

For more details and usage information on Rule, see the guide article on security authorization.

Properties

Property	Type	Description	Defined by
`$createdAt`	`int`	UNIX timestamp representing the rule creation time Default: `null`.	`Rule`
`$name`	`string`	Name of the rule Default: `null`.	`Rule`
`$updatedAt`	`int`	UNIX timestamp representing the rule updating time Default: `null`.	`Rule`

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`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`
`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()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`execute()` abstract	Executes the rule.	`Rule`
`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()`	Initializes the object.	`yii\base\BaseObject`

abstract public function execute(string|int $user, yii\rbac\Item $item, array $params): bool

Executes the rule.

Parameters

Parameter	Type	Description
`$user`	`string\|int`	The user ID. This should be either an integer or a string representing the unique identifier of a user. See `User::$id`.
`$item`	`Item`	The role or permission that this rule is associated with
`$params`	`array`	Parameters passed to `CheckAccessInterface::checkAccess()`.

Returns

bool: A value indicating whether the rule permits the auth item it is associated with.