label305/permissions-component

Permissions component

Permissions Component

Eases up fetching CRUD permissions from models., _(*1)

No maintenance intended, _(*2)

This project is no longer actively maintained. It does its job, but there are no plans to extend or change it., _(*3)

Install

Add the repository to your requirements and load using composer, _(*4)

    "require": {
        "label305/permissions-component": "dev-master"
    }

Add to your app's components, _(*5)

public $components = array(
    'PermissionsComponent.Permissions'
);

Usage

Setup authentication using the Auth component and define a user model, _(*6)

public $components = array(
    'Auth' => array(
        'authenticate' => array(
            'Form' => array(
                'userModel' => 'YourUserModel'
                )
            )
        )
    );

After that the Permissions component will use the YourUserModel as the PermissibleModel passed in the options to your CRUD methods., _(*7)

For example:, _(*8)

public function canUpdate($options) {
    $result = false;

    switch($options['PermissibleModel']) {
        case 'PermAccount':
            if(isset($options['PermissibleId'], $options['id'])) {
                $this->id = $options['id'];
                $result = $this->field('perm_account_id') == $options['PermissibleId'];
            }
        break; 
    }
    return $result;
}

This will check if the requested item with $options['id'] has the perm_account_id matching to the logged in user. It is possible to do authentication with multiple models, when, for example, you also want to define permissions to something like an api key. You only need to change the userModel used by the Authentication component, _(*9)

Admin users

For convenience you can define an "isAdmin" method in your user model, when the method is defined the permissions component will always first poll this method. If the method returns true, it will allow the authenticated user to do everything., _(*10)

License

Copyright 2014 Label305 B.V., _(*11)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at, _(*12)

http://www.apache.org/licenses/LICENSE-2.0, _(*13)

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License., _(*14)