RoleManager Class Reference

Public Member Functions
	RoleManager ()

Static Public Member Functions
static	deleteRoleFromString (&$items, $del_role, $field="")
static	addRoleToAccessList ($items, $role, $field="role")
	Adds the specified role to the access list field in each of the supplied DataItems. More...
static	removeRoleFromAccessList ($items, $role, $field="role")
	Removes the specified role from the access list field in each of the supplied DataItems. More...
static	registerSerializationHandler ()
static	upgradeComponent ($version)

Detailed Description

Definition at line 41 of file role_manager.inc.

Member Function Documentation

addRoleToAccessList()

static RoleManager::addRoleToAccessList (   $items,   $role,   $field = "role"  )

static

Adds the specified role to the access list field in each of the supplied DataItems.

Parameters

mixed	$items	the DataItem or array of DataItems to be updated
string	$role	the role to add to the access list field
string	$field	the name of the field (default is 'role')

Definition at line 93 of file role_manager.inc.

     {
          if (count($items) == 0) return;
          if (is_object($items))
          {
               if (!$items instanceof DataItem) return;
               $items = array( $items );
          }
          
          foreach($items as $item)
          {
               if (!$item->hasField($field)) continue;
                              
               $roles = explode(",", $item->get($field));
               $found = false;
               foreach($roles as $r)
               {
                    if ($r == $role)
                    {
                         $found = true;
                         break;
                    }
               }
               
               if (!$found)
               {
                    $roles[] = $role;
                    $oldFilter = $item->filter;
                    $item->filter = new InclusionFilter($field);
                    $item->set($field, implode(",", $roles));
                    $item->save();
                    $item->filter = $oldFilter;
               }
          }
     }

deleteRoleFromString()

static RoleManager::deleteRoleFromString ( &  $items,   $del_role,   $field = ""  )

static

Deprecated:

Called by ComponentManager, PageManager, UserManager, and MenuItemManager

Definition at line 53 of file role_manager.inc.

     {
          if(count($items) == 0)
               return;
               
          if(!$field)
               $field = "role";
 
          foreach($items as $item)
          {
               if(!$item->$field)
                    continue;
                    
               $newRoles = array();
               
               $roles = explode(",", $item->$field);
               foreach($roles as $role)
               {
                    if(!preg_match("/$del_role/", $role))
                         $newRoles[] = $role;
               }    
                    
               if(count($newRoles) > 0)
                    $newRole = implode(",", $newRoles);
               else
                    $newRole = "";
               
               $item->$field = $newRole;
               $item->filter = new InclusionFilter($field);
               $item->save();
          }
     }

registerSerializationHandler()

static RoleManager::registerSerializationHandler ( )

static

Definition at line 175 of file role_manager.inc.

     {
          SerializationManager::registerHandler("role", "Roles", new SimpleSerializationHandler(SiteRole));
     }

removeRoleFromAccessList()

static RoleManager::removeRoleFromAccessList (   $items,   $role,   $field = "role"  )

static

Removes the specified role from the access list field in each of the supplied DataItems.

Parameters

mixed	$items	the DataItem or array of DataItems to be updated
string	$role	the role to add to the access list field
string	$field	the name of the field (default is 'role')

Definition at line 136 of file role_manager.inc.

     {
          if (count($items) == 0) return;
          if (is_object($items))
          {
               if (!$items instanceof DataItem) return;
               $items = array( $items );
          }
          
          foreach($items as $item)
          {
               if (!$item->hasField($field)) continue;
               
               $roles = explode(",", $item->get($field));
               $newRoles =array();
               $found = false;
               foreach($roles as $r)
               {
                    if ($r == $role)
                    {
                         $found = true;
                    }
                    else
                    {
                         $newRoles[] = $r;
                    }
               }
               
               if ($found)
               {
                    $oldFilter = $item->filter;
                    $item->filter = new InclusionFilter($field);
                    $item->set($field, implode(",", $newRoles));
                    $item->save();
                    $item->filter = $oldFilter;
               }
          }
     }

RoleManager()

RoleManager::RoleManager

(

)

Definition at line 43 of file role_manager.inc.

     {
          
     }

upgradeComponent()

static RoleManager::upgradeComponent (   $version )

static

Definition at line 180 of file role_manager.inc.

     {
          $mgr = new RoleUpgradeManager();
          $mgr->upgrade($version);
     }    

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/role/role_manager.inc