1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 <?php
/**
***********************************************************************************************
* @copyright 2004-2016 The Admidio Team
* @see http://www.admidio.org/
* @license https://www.gnu.org/licenses/gpl-2.0.html GNU General Public License v2.0 only
***********************************************************************************************
*/
/**
* @class RolesRights
* @brief Manages a special right of the table adm_roles_rights for a special object.
*
* This class will manage roles rights for a specific object. The possible rights are defined
* within the table adm_roles_rights. The assigned roles will be stored within the table
* adm_roles_rights_data. There is also the link to the specific object. The assigned roles
* of the object could be managed with this class. You can add or remove roles and check if a
* user has access to the specific right.
* @par Examples
* @code // check if the current user has the right to view a folder of the download module
* $folderViewRolesObject = new RolesRights($gDb, 'folder_view', $folderId);
* if($folderViewRolesObject->hasRight($gCurrentUser->getRoleMemberships()))
* {
* // do something
* } @endcode
* @code // add new roles to the special roles right of a folder
* $folderViewRolesObject = new RolesRights($gDb, 'folder_view', $folderId);
* $folderViewRolesObject->addRoles(array(2, 5)); @endcode
*/
class RolesRights extends TableAccess
{
protected $rolesRightsDataObjects;
protected $rolesIds; ///< Array with all roles ids as values
protected $objectId; ///< Id of the object for which the roles right should be loaded.
protected $rolesRightName; ///< Name of the current role right
/**
* Constructor that will create an object of a recordset of the table adm_roles_rights.
* If the id is set than the specific category will be loaded.
* @param \Database $database Object of the class Database. This should be the default global object @b $gDb.
* @param string $rolesRightName The recordset of the roles right with this name will be loaded.
* @param string $objectId Id of the object of which the roles should be loaded.
*/
public function __construct(&$database, $rolesRightName, $objectId)
{
parent::__construct($database, TBL_ROLES_RIGHTS, 'ror');
$this->rolesRightName = $rolesRightName;
$this->objectId = $objectId;
$this->readDataByColumns(array('ror_name_intern' => $rolesRightName));
}
/**
* Add all roles of the parameter array to the current roles rights object.
* @param int[] $roleIds Array with all role ids that should be add.
*/
public function addRoles(array $roleIds)
{
foreach($roleIds as $roleId)
{
if(!in_array((int) $roleId, $this->rolesIds, true))
{
$rolesRightsData = new TableAccess($this->db, TBL_ROLES_RIGHTS_DATA, 'rrd');
$rolesRightsData->setValue('rrd_ror_id', $this->getValue('ror_id'));
$rolesRightsData->setValue('rrd_rol_id', $roleId);
$rolesRightsData->setValue('rrd_object_id', $this->objectId);
$rolesRightsData->save();
$this->rolesRightsDataObjects[$roleId] = $rolesRightsData;
$this->rolesIds[] = (int) $roleId;
}
}
}
/**
* Check if one of the assigned roles is also a role of the current object.
* Method will return true if at least one role was found.
* @param int[] $assignedRoles Array with all assigned roles of the user whose rights should be checked
* @return bool Return @b true if at least one role of the assigned roles exists at the current object.
*/
public function hasRight(array $assignedRoles)
{
return count($assignedRoles) > 0 && count(array_intersect($this->rolesIds, $assignedRoles)) > 0;
}
/**
* Initializes all class parameters and deletes all read data.
*/
public function clear()
{
$this->rolesRightsDataObjects = array();
$this->rolesIds = array();
parent::clear();
}
/**
* Deletes all assigned roles to the current object.
* After that the class will be initialize.
* @return bool @b true if no error occurred
*/
public function delete()
{
if(count($this->rolesRightsDataObjects) > 0)
{
$this->db->startTransaction();
foreach($this->rolesRightsDataObjects as $object)
{
$object->delete();
}
$this->clear();
$this->db->endTransaction();
}
return true;
}
/**
* Get all roles ids that where assigned to the current roles right and the selected object.
* @return int[] Returns an array with all role ids
*/
public function getRolesIds()
{
return $this->rolesIds;
}
/**
* Reads a record out of the table in database selected by the conditions of the param @b $sqlWhereCondition out of the table.
* If the sql will find more than one record the method returns @b false.
* Per default all columns of the default table will be read and stored in the object.
* @param string $sqlWhereCondition Conditions for the table to select one record
* @return bool Returns @b true if one record is found
* @see TableAccess#readDataById
* @see TableAccess#readDataByColumns
*/
protected function readData($sqlWhereCondition)
{
if(parent::readData($sqlWhereCondition))
{
$sql = 'SELECT * FROM '.TBL_ROLES_RIGHTS_DATA.'
WHERE rrd_ror_id = '.$this->getValue('ror_id').'
AND rrd_object_id = '.$this->objectId;
$rolesRightsStatement = $this->db->query($sql);
while($row = $rolesRightsStatement->fetch())
{
$this->rolesRightsDataObjects[$row['rrd_rol_id']] = new TableAccess($this->db, TBL_ROLES_RIGHTS_DATA, 'rrd');
$this->rolesRightsDataObjects[$row['rrd_rol_id']]->setArray($row);
$this->rolesIds[] = (int) $row['rrd_rol_id'];
}
}
return false;
}
/**
* Remove all roles of the parameter array from the current roles rights object.
* @param int[] $roleIds Array with all role ids that should be removed.
*/
public function removeRoles(array $roleIds)
{
foreach($roleIds as $roleId)
{
if(in_array((int) $roleId, $this->rolesIds, true))
{
$this->rolesRightsDataObjects[$roleId]->delete();
}
}
}
}