Projects / Osmosis

<?php
/* SVN FILE: $Id$ */
/**
 * Ósmosis LMS: <http://www.osmosislms.org/>
 * Copyright 2008, Ósmosis LMS
 *
 * This file is part of Ósmosis LMS.
 * Ósmosis LMS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Ósmosis LMS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Ósmosis LMS.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @filesource
 * @copyright		Copyright 2008, Ósmosis LMS
 * @link			http://www.osmosislms.org/
 * @package			org.osmosislms
 * @subpackage		org.osmosislms.app
 * @since			Version 2.0 
 * @version			$Revision$
 * @modifiedby		$LastChangedBy$
 * @lastmodified	$Date$
 * @license			http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
 */
class Role extends AppModel {

	var $name = 'Role';
	var $displayField = 'role';

	/**
	 * Attached behaviors
	 *
	 * @var array
	 **/
    var $actsAs = array('Acl' => array('type' => 'requester'));

	/**
	 * BelongsTo (1-N) relation descriptors
	 *
	 * @var array
	 **/
	var $belongsTo = array(
		// Role BelongsTo Role (Parent Role in a hierarchy)
		'Parent' => array(
			'className' => 'Role',
			'foreignKey' => 'parent_id'
		)
	);

	/**
	 * Returns the parentNode in the Roles hierarchy
	 *
	 * @see AclBehavior
	 */	
    function parentNode() {
        if (!$this->id) {
            return null;
        }
        $data = $this->read();
        if (!$data[$this->name]['parent_id']){
            return null;
        } else {
            return array('model' => 'Role', 'foreign_key' => $data[$this->name]['parent_id']);
        }
    }
	
	/**
	 * Compares 2 roles based on their permission degree, a Higher ranked role means it has access clearance
	 *
	 * @param string $a Human readable role name
	 * @param string $b Human readable role name
	 * @return int o if $a == $b, 1 if $a > $b, 0 otherwise
	 */
	
	function compare($a,$b) {
		if ($a == $b)
			return 0;
		$roles =  $this->find('all',array('conditions' => array('role' => array($a,$b)),'recursive' => -1));
		return (Set::extract('/Role[role='.$a.']/id',$roles) > Set::extract('/Role[role='.$b.']/id',$roles)) ? 1 : -1;
	}
}
?>