Class Role

This model describes the roles that can be affected to the users

Hawk\Model uses Hawk\Utils

Extended by

Hawk\Role

Namespace: Hawk
Package: BaseModels
Located at models/Role.php

Methods summary

`public static array`	# `getAll( string $index = null, array $fields = array(), array $order = array(), boolean $includeGuest = false )` Get all roles Get all roles Parameters `$index` The field to use as key in the returned array `$fields` The fields to get for each role. If not set, all table fields are got `$order` The order instructions for the returned array `$includeGuest` If set to true, then include 'Guest' role to the result Returns array The roles list Overrides `Hawk\Model::getAll`
`public boolean`	# `isRemovable( )` Check if the role is removable. A role is removable if it's not 'Guest' or 'Admin', and not the default role Check if the role is removable. A role is removable if it's not 'Guest' or 'Admin', and not the default role Returns boolean
`public string`	# `getLabel( )` Get the label of the role in the current language Get the label of the role in the current language Returns string

Methods inherited from Hawk\Model

__construct(), add(), addIfNotExists(), countElementsByExample(), countElementsBySQL(), delete(), deleteByExample(), deleteBySQL(), getByExample(), getById(), getBySQL(), getData(), getDbInstance(), getDbName(), getListByExample(), getListBySQL(), getPrimaryColumn(), getTable(), save(), set(), setDbName(), setPrimaryColumn(), setTable(), update()

Methods used from Hawk\Utils

debug(), getSerializedVersion(), map()

Constants summary

`integer`	`GUEST_ROLE_ID` The id corresponding to the 'Guest' role The id corresponding to the 'Guest' role	# `0`
`integer`	`ADMIN_ROLE_ID` The id corresponding to the 'Admin' role The id corresponding to the 'Admin' role	# `1`

Properties summary

`public static string`	`$tablename` The associated table The associated table	# `"Role"`

Properties inherited from Hawk\Model

$dbname, $primaryColumn