Class luya\admin\components\Auth
Inheritance | luya\admin\components\Auth » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 1.0.0 |
Source Code | https://github.com/luyadev/luya-module-admin/blob/master/src/components/Auth.php |
Auth components gives informations about permissions, who can do what.
In order to understand the permission weights read the [[app-admin-module-permission.md]] section.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
$databaseAuths | array | luya\admin\components\Auth | |
$permissionApiEndpointsTable | array | An array with all api endpoints from the permission system indexed by the api name. | luya\admin\components\Auth |
$permissionRoutesTable | array | An array with all api endpoints from the permission system indexed by the api name. | luya\admin\components\Auth |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Component |
__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 a component property. | yii\base\Component |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
__set() | Sets the value of a component property. | yii\base\Component |
__unset() | Sets a component property to be null. | yii\base\Component |
addApi() | Add a new api route to the permission system (admin_auth) | luya\admin\components\Auth |
addRoute() | Add a new route to the permission system (admin_auth) | luya\admin\components\Auth |
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\Component |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
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 |
executeCleanup() | Execute the data to delete based on an array containing a key 'id' with the corresponding value from the Database. | luya\admin\components\Auth |
getApiTable() | Get the data for a given api and user. | luya\admin\components\Auth |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getDatabaseAuths() | Returns the current available auth rules inside the admin_auth table splied into routes and apis. | luya\admin\components\Auth |
getPermissionApiEndpointsTable() | Get all api endpoints as array with index by api endpoitn name | luya\admin\components\Auth |
getPermissionRoutesTable() | Get all api endpoints as array with index by api endpoitn name | luya\admin\components\Auth |
getPermissionTable() | Get all permissions entries for the given User. | luya\admin\components\Auth |
getPermissionTableDistinct() | Get the permission table for a user without doublicated entries. | luya\admin\components\Auth |
getRouteTable() | Get the data for a given route and user. | luya\admin\components\Auth |
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\Component |
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
init() | Initializes the object. | yii\base\BaseObject |
isInApiEndpointPermissionTable() | Check if a given api endpoint is in the permission (auth) system available. | luya\admin\components\Auth |
isInRoutePermissionTable() | Check if a given route exists in permission system. | luya\admin\components\Auth |
matchApi() | See if a User have rights to access this api. | luya\admin\components\Auth |
matchRoute() | See if the user has permitted the provided route. | luya\admin\components\Auth |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
permissionVerify() | Verify a permission type against its calculated weight . |
luya\admin\components\Auth |
permissionWeight() | Calculate the weight from whether the user can create, udpate and/or delete. | luya\admin\components\Auth |
prepareCleanup() | The method returns all rows which are not provided in $array. If an api/route is in the $data array its a valid rule and will not be prepared to find for deletion. Negativ array behavior. | luya\admin\components\Auth |
trigger() | Triggers an event. | yii\base\Component |
Protected Methods
Method | Description | Defined By |
---|---|---|
normalizeIdentityOrId() | Normalize the given input user id or identity interface to an id. | luya\admin\components\Auth |
Constants
Constant | Value | Description | Defined By |
---|---|---|---|
CAN_CREATE | 1 | luya\admin\components\Auth | |
CAN_DELETE | 3 | luya\admin\components\Auth | |
CAN_UPDATE | 2 | luya\admin\components\Auth | |
CAN_VIEW | 0 | luya\admin\components\Auth |
Property Details
An array with all api endpoints from the permission system indexed by the api name.
An array with all api endpoints from the permission system indexed by the api name.
Method Details
Defined in: yii\base\Component::__call()
Calls the named method which is not a class method.
This method will check if any attached behavior has the named method and will execute it if available.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
public mixed __call ( $name, $params ) | ||
$name | string |
The method name |
$params | array |
Method parameters |
return | mixed |
The method return value |
---|---|---|
throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\Component::__clone()
This method is called after the object is created by cloning an existing one.
It removes all behaviors because they are attached to the old object.
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
public void __construct ( $config = [] ) | ||
$config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\Component::__get()
Returns the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $component->property;
.
See also __set().
public mixed __get ( $name ) | ||
$name | string |
The property name |
return | mixed |
The property value or the value of a behavior's property |
---|---|---|
throws | yii\base\UnknownPropertyException |
if the property is not defined |
throws | yii\base\InvalidCallException |
if the property is write-only. |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__isset()
Checks if a property is set, i.e. defined and not null.
This method will check in the following order and act accordingly:
- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return
false
for non existing properties
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($component->property)
.
public boolean __isset ( $name ) | ||
$name | string |
The property name or the event name |
return | boolean |
Whether the named property is set |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
Defined in: yii\base\Component::__set()
Sets the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $component->property = $value;
.
See also __get().
public void __set ( $name, $value ) | ||
$name | string |
The property name or the event name |
$value | mixed |
The property value |
throws | yii\base\UnknownPropertyException |
if the property is not defined |
---|---|---|
throws | yii\base\InvalidCallException |
if the property is read-only. |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__unset()
Sets a component property to be null.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($component->property)
.
public void __unset ( $name ) | ||
$name | string |
The property name |
throws | yii\base\InvalidCallException |
if the property is read only. |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
Add a new api route to the permission system (admin_auth)
public integer addApi ( $moduleName, $apiEndpoint, $name, $pool = null ) | ||
$moduleName | string |
The name of the module where the route is located. |
$apiEndpoint | string |
An API endpoint name like |
$name | string |
A readable name for the api to display in the permission system. |
$pool | string |
public function addApi($moduleName, $apiEndpoint, $name, $pool = null)
{
$where = ['api' => $apiEndpoint];
if (!empty($pool)) {
$where['pool'] = $pool;
}
$model = AuthModel::find()->where($where)->one();
if (!$model) {
$model = new AuthModel();
}
$model->alias_name = $name;
$model->module_name = $moduleName;
$model->pool = $pool;
$model->api = $apiEndpoint;
$model->is_crud = 1;
$model->save();
return $model->id;
}
Add a new route to the permission system (admin_auth)
public integer addRoute ( $moduleName, $route, $name ) | ||
$moduleName | string |
The name of the module where the route is located. |
$route | string |
The route which is an identifier. |
$name | string |
A readable name for the route to display in the permissions system. |
throws | luya\Exception |
---|
public function addRoute($moduleName, $route, $name)
{
$model = AuthModel::find()->where(['route' => $route])->one();
if (!$model) {
$model = new AuthModel();
}
$model->alias_name = $name;
$model->module_name = $moduleName;
$model->route = $route;
$model->save();
return $model->id;
}
Defined in: yii\base\Component::attachBehavior()
Attaches a behavior to this component.
This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.
See also detachBehavior().
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
The name of the behavior. |
$behavior | string|array|yii\base\Behavior |
The behavior configuration. This can be one of the following:
|
return | yii\base\Behavior |
The behavior object |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in: yii\base\Component::attachBehaviors()
Attaches a list of behaviors to the component.
Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.
See also attachBehavior().
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
List of behaviors to be attached to the component |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
Defined in: yii\base\Component::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 yii\base\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).
public array behaviors ( ) | ||
return | array |
The behavior configurations. |
---|
public function behaviors()
{
return [];
}
Defined in: yii\base\Component::canGetProperty()
Returns a value indicating whether a property can be read.
A property can be read if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a readable property of the given name (when
$checkBehaviors
is true).
See also canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be read |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::canSetProperty()
Returns a value indicating whether a property can be set.
A property can be written if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a writable property of the given name (when
$checkBehaviors
is true).
See also canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be written |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
public static string className ( ) | ||
return | string |
The fully qualified name of this class. |
---|
public static function className()
{
return get_called_class();
}
Defined in: yii\base\Component::detachBehavior()
Detaches a behavior from the component.
The behavior's yii\base\Behavior::detach() method will be invoked.
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
The behavior's name. |
return | yii\base\Behavior|null |
The detached behavior. Null if the behavior does not exist. |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
Defined in: yii\base\Component::detachBehaviors()
Detaches all behaviors from the component.
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
Defined in: yii\base\Component::ensureBehaviors()
Makes sure that the behaviors declared in behaviors() are attached to this component.
public void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
Execute the data to delete based on an array containing a key 'id' with the corresponding value from the Database.
public boolean executeCleanup ( array $data ) | ||
$data | array |
public function executeCleanup(array $data)
{
foreach ($data as $rule) {
Yii::$app->db->createCommand()->delete('{{%admin_auth}}', 'id=:id', ['id' => $rule['id']])->execute();
Yii::$app->db->createCommand()->delete('{{%admin_group_auth}}', 'auth_id=:id', ['id' => $rule['id']])->execute();
}
return true;
}
Get the data for a given api and user.
public array getApiTable ( $userId, $apiEndpoint ) | ||
$userId | integer |
The user id the find the data from. |
$apiEndpoint | string |
The api endpoint to find from the permission system. |
public function getApiTable($userId, $apiEndpoint)
{
$data = [];
foreach ($this->getPermissionTable($userId) as $item) {
if ($item['api'] == $apiEndpoint && $item['user_id'] == $userId) {
$data[] = $item;
}
}
return $data;
}
Defined in: yii\base\Component::getBehavior()
Returns the named behavior object.
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
The behavior name |
return | yii\base\Behavior|null |
The behavior object, or null if the behavior does not exist |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
Defined in: yii\base\Component::getBehaviors()
Returns all behaviors attached to this component.
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
List of behaviors attached to this component |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
Returns the current available auth rules inside the admin_auth table splied into routes and apis.
public array getDatabaseAuths ( ) |
public function getDatabaseAuths()
{
// define response structure of array
$data = [
'routes' => [],
'apis' => [],
];
// get all auth data
foreach ((new Query())->select('*')->from('{{%admin_auth}}')->all() as $item) {
// allocate if its an api or route. More differences?
if (empty($item['api'])) {
$data['routes'][] = $item;
} else {
$data['apis'][] = $item;
}
}
return $data;
}
Get all api endpoints as array with index by api endpoitn name
public array getPermissionApiEndpointsTable ( ) | ||
return | array |
An array with all api endpoints from the permission system indexed by the api name. |
---|
public function getPermissionApiEndpointsTable()
{
if (!$this->_endpoints) {
$this->_endpoints = AuthModel::find()->andWhere(['not', ['api' => null]])->indexBy('api')->asArray()->all();
}
return $this->_endpoints;
}
Get all api endpoints as array with index by api endpoitn name
public array getPermissionRoutesTable ( ) | ||
return | array |
An array with all api endpoints from the permission system indexed by the api name. |
---|
public function getPermissionRoutesTable()
{
if (!$this->_routes) {
$this->_routes = AuthModel::find()->andWhere(['not', ['route' => null]])->indexBy('route')->asArray()->all();
}
return $this->_routes;
}
Get all permissions entries for the given User.
public array getPermissionTable ( $userId ) | ||
$userId | integer |
The user id to retrieve the data for. |
public function getPermissionTable($userId)
{
if (!array_key_exists($userId, $this->_permissionTable)) {
$this->_permissionTable[$userId] = (new Query())
->select(['*'])
->from('{{%admin_user_group}}')
->innerJoin('{{%admin_group_auth}}', '{{%admin_user_group}}.group_id={{%admin_group_auth}}.group_id')
->innerJoin('{{%admin_auth}}', '{{%admin_group_auth}}.auth_id = {{%admin_auth}}.id')
->where(['{{%admin_user_group}}.user_id' => $userId])
->all();
}
return $this->_permissionTable[$userId];
}
Get the permission table for a user without doublicated entries.
As its possible to have multiple groups with the same permissions.
public array getPermissionTableDistinct ( $userId ) | ||
$userId | integer |
public function getPermissionTableDistinct($userId)
{
return ArrayHelper::index($this->getPermissionTable($userId), 'id');
}
Get the data for a given route and user.
public array getRouteTable ( $userId, $route ) | ||
$userId | integer |
The user id the find the data from. |
$route | string |
The route to find from the permission system. |
public function getRouteTable($userId, $route)
{
$data = [];
foreach ($this->getPermissionTable($userId) as $item) {
if ($item['route'] == $route && $item['user_id'] == $userId) {
$data[] = $item;
}
}
return $data;
}
Defined in: yii\base\Component::hasEventHandlers()
Returns a value indicating whether there is any handler attached to the named event.
public boolean hasEventHandlers ( $name ) | ||
$name | string |
The event name |
return | boolean |
Whether there is any handler attached to the event. |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
Defined in: yii\base\Component::hasMethod()
Returns a value indicating whether a method is defined.
A method is defined if:
- the class has a method with the specified name
- an attached behavior has a method with the given name (when
$checkBehaviors
is true).
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkBehaviors | boolean |
Whether to treat behaviors' methods as methods of this component |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::hasProperty()
Returns a value indicating whether a property is defined for this component.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a property of the given name (when
$checkBehaviors
is true).
See also:
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property is defined |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Defined in: yii\base\BaseObject::init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |
public function init()
{
}
Check if a given api endpoint is in the permission (auth) system available.
This does not mean any given user has access to this endpoint.
public boolean isInApiEndpointPermissionTable ( $apiEndpoint ) | ||
$apiEndpoint | string |
The api endpoint to validate. |
public function isInApiEndpointPermissionTable($apiEndpoint)
{
return array_key_exists($apiEndpoint, $this->getPermissionApiEndpointsTable());
}
Check if a given route exists in permission system.
This does not mean any given user has access to this endpoint.
public boolean isInRoutePermissionTable ( $route ) | ||
$route | string |
public function isInRoutePermissionTable($route)
{
return array_key_exists($route, $this->getPermissionRoutesTable());
}
See if a User have rights to access this api.
public boolean|integer matchApi ( $userId, $apiEndpoint, $typeVerification = false ) | ||
$userId | integer|yii\web\IdentityInterface | |
$apiEndpoint | string |
As defined in the Module.php like (api-admin-user) which is a unique identifiere |
$typeVerification | integer|string |
The CONST number provided from CAN_* or false if none (which is equals: VIEW) |
return | boolean|integer |
Return false or the auth id, if this a can view request also bool is returned |
---|
public function matchApi($userId, $apiEndpoint, $typeVerification = false)
{
$groups = $this->getApiTable($this->normalizeIdentityOrId($userId), $apiEndpoint);
if ($typeVerification === false || $typeVerification === self::CAN_VIEW) {
return count($groups) > 0 ? current($groups)['id'] : false;
}
foreach ($groups as $row) {
if ($this->permissionVerify($typeVerification, $this->permissionWeight($row['crud_create'], $row['crud_update'], $row['crud_delete']))) {
return $row['id'];
}
}
return false;
}
See if the user has permitted the provided route.
public boolean|integer matchRoute ( $userId, $route ) | ||
$userId | integer|yii\web\IdentityInterface |
The user id from admin users |
$route | string |
The route to test. |
return | boolean|integer |
Returns false or the id of the auth |
---|
public function matchRoute($userId, $route)
{
$groups = $this->getRouteTable($this->normalizeIdentityOrId($userId), $route);
if (is_array($groups) && count($groups) > 0) {
return current($groups)['id'];
}
return false;
}
Normalize the given input user id or identity interface to an id.
protected integer normalizeIdentityOrId ( $user ) | ||
$user | integer|string|yii\web\IdentityInterface | |
return | integer |
The user id as int value |
---|
protected function normalizeIdentityOrId($user)
{
if ($user instanceof IdentityInterface) {
return $user->getId();
}
if (is_scalar($user)) {
return $user;
}
return 0;
}
Defined in: yii\base\Component::off()
Detaches an existing event handler from this component.
This method is the opposite of on().
Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.
See also on().
public boolean off ( $name, $handler = null ) | ||
$name | string |
Event name |
$handler | callable|null |
The event handler to be removed. If it is null, all handlers attached to the named event will be removed. |
return | boolean |
If a handler is found and detached |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
Defined in: yii\base\Component::on()
Attaches an event handler to an event.
The event handler must be a valid PHP callback. The following are some examples:
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
The event handler must be defined with the following signature,
function ($event)
where $event
is an yii\base\Event object which includes parameters associated with the event.
Since 2.0.14 you can specify event name as a wildcard pattern:
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
See also off().
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
The event name |
$handler | callable |
The event handler |
$data | mixed |
The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data. |
$append | boolean |
Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list. |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
Verify a permission type against its calculated weight
.
In order to calculate the permissions weight see {{\luya\admin\components\Auth::permissionWeight()}}.
public boolean permissionVerify ( $type, $permissionWeight ) | ||
$type | string |
The type of permission (1,2,3 see constants) |
$permissionWeight | integer |
A weight of the permssions which is value between 1 - 9, see [[app-admin-module-permission.md]]. |
public function permissionVerify($type, $permissionWeight)
{
$numbers = [];
switch ($type) {
case self::CAN_CREATE:
$numbers = [1, 4, 6, 9];
break;
case self::CAN_UPDATE:
$numbers = [3, 4, 8, 9];
break;
case self::CAN_DELETE:
$numbers = [5, 6, 8, 9];
break;
}
return in_array($permissionWeight, $numbers);
}
Calculate the weight from whether the user can create, udpate and/or delete.
public \luya\admin\components\number permissionWeight ( $create, $update, $delete ) | ||
$create | integer |
Whether the user can create new records |
$update | integer |
Whether the user can update records. |
$delete | integer |
Whether the user can delete records. |
return | \luya\admin\components\number |
The calculated weight of the permissions based on the input. |
---|
public function permissionWeight($create, $update, $delete)
{
$create = $create ? 1 : 0;
$update = $update ? 3 : 0;
$delete = $delete ? 5 : 0;
return ($create + $update + $delete);
}
The method returns all rows which are not provided in $array. If an api/route is in the $data array its a valid rule and will not be prepared to find for deletion. Negativ array behavior.
$data = [
'apis' => ['api-admin-test', 'api-admin-foo'],
'routes' => ['route-to-sth', 'foo-bar-bar'],
];
The above provided data are valid rules.
public array prepareCleanup ( array $ids ) | ||
$ids |
public function prepareCleanup(array $ids)
{
return AuthModel::find()->where(['not in', 'id', $ids])->asArray()->all();
}
Defined in: yii\base\Component::trigger()
Triggers an event.
This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
The event name |
$event | yii\base\Event|null |
The event instance. If not set, a default yii\base\Event object will be created. |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}