SiteRole Class Reference

Inherits DataItem.

Public Member Functions
	Site ()
	SiteRole ()

Static Public Member Functions
static	getRolesArray ()
	Retrieves the array of roles and their names for the current site for use in a CMS form. More...
static	getRole ($role)
static	getRoleLookup ()
static	getHomePage ($account=null)
static	getRoleNames ($role)

Public Attributes
	$fields
	$relations = array("Site" => Site)

Detailed Description

Definition at line 42 of file role.inc.

Member Function Documentation

getHomePage()

static SiteRole::getHomePage (   $account = null )

static

Definition at line 102 of file role.inc.

     {
          $roles = SiteRole::getRoleLookup();
          foreach($roles as $role => $details)
          {
               if (checkRole($role, $account)) return $details->home_page;
          }
          
          return "";
     }

getRole()

static SiteRole::getRole (   $role )

static

Definition at line 90 of file role.inc.

     {
          $names = query(SiteRole, "WHERE role='$role'");
          if(count($names) > 0)
               return $names[0];
     }

getRoleLookup()

static SiteRole::getRoleLookup ( )

static

Definition at line 97 of file role.inc.

     {
          return IndexedQuery::create(SiteRole, "ORDER by priority, name", "role")->execute();
     }

getRoleNames()

static SiteRole::getRoleNames (   $role )

static

Definition at line 118 of file role.inc.

     {
          $roles = explode(",", $role);
          if(count($roles) > 0)
          {
               foreach($roles as $role)
               {
                    $name = SiteRole::getRole($role);
                    if($name)
                         $names[] = $name->name;
               }
          }
     
          return implode(", ", array_values($names));
     }

getRolesArray()

static SiteRole::getRolesArray ( )

static

Retrieves the array of roles and their names for the current site for use in a CMS form.

Returns

array

Definition at line 75 of file role.inc.

     {
          $roles = query(SiteRole, "WHERE role!='super' ORDER BY priority, name");
          
          $rarr = array();
          
          foreach($roles as $role)
          {
               $rarr[$role->role] = $role->name;
          }
          
          return $rarr;
     }

Site()

SiteRole::Site

(

)

Definition at line 57 of file role.inc.

     {
          return $this->getRelated(Site);
     }

SiteRole()

SiteRole::SiteRole

(

)

Definition at line 62 of file role.inc.

     {
          $this->table = "site_role";
          $this->primary_key = "role_id";
          $this->default_format = "{name}";
          
          $this->DataItem(func_get_args());
     }

Member Data Documentation

$fields

SiteRole::$fields

Initial value:

= array("role_id"        =>   Number,
                              "role"              =>   String,
                              "name"              =>   String,
                              "description"  =>   Text,
                              "priority"          =>   Number,
                              "home_page"         =>   String)

Definition at line 46 of file role.inc.

$relations

SiteRole::$relations = array("Site" => Site)

Definition at line 55 of file role.inc.

---

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

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