Permission

Extends \LSActiveRecord

Methods

Returns the table's name

tableName() : string
access

public

Response

string

Returns the static model of Settings table

model(string $class = __CLASS__) : \Permission
static
static
access

public

Arguments

$class

string

Response

\Permission

Returns the base permissions

getSurveyBasePermissions() : array
static
access

public

static

Response

array

Returns the global permissions including description and title

getGlobalBasePermissions() : array
static
access

public

static

Response

array

getPermissions

getPermissions($iUserID, $iEntityID = null, $sEntityName = null) 
static

Arguments

$iUserID

$iEntityID

$sEntityName

Sets permissions (global or survey-specific) for a survey administrator Checks what permissions may be set and automatically filters invalid ones.

setPermissions(mixed $iUserID, mixed $iEntityID, string $sEntityName, mixed $aPermissions, boolean $bBypassCheck = false) 
static

A permission may be invalid if the permission does not exist or that particular user may not give that permission

Arguments

$iUserID

mixed

$iEntityID

mixed

$sEntityName

string

$aPermissions

mixed

$bBypassCheck

boolean

Set global permissions to the user id

setGlobalPermission(int $iNewUID, string $sPermType, string[] $aPermissions = array('read_p')) 

Arguments

$iNewUID

int

$sPermType

string

$aPermissions

string[]

giveAllSurveyPermissions

giveAllSurveyPermissions($iUserID, integer $iSurveyID) 

Arguments

$iUserID

$iSurveyID

integer

insertRecords

insertRecords($data) 

Arguments

$data

insertSomeRecords

insertSomeRecords($data) 

Arguments

$data

getUserDetails

getUserDetails($surveyid) 

Arguments

$surveyid

copySurveyPermissions

copySurveyPermissions($iSurveyIDSource, $iSurveyIDTarget) 

Arguments

$iSurveyIDSource

$iSurveyIDTarget

Checks if a user has a certain permission

hasPermission(mixed $iEntityID, string $sEntityName, mixed $sPermission, mixed $sCRUD = 'read', mixed $iUserID = null) : bool

Arguments

$iEntityID

mixed

integer The entity ID

$sEntityName

string

string The entity name

$sPermission

mixed

string Name of the permission

$sCRUD

mixed

string The permission detail you want to check on: 'create','read','update','delete','import' or 'export'

$iUserID

mixed

integer User ID - if not given the one of the current user is used

Response

bool

True if user has the permission

Returns true if a user has global permission for a certain action.

hasGlobalPermission(string $sPermission, mixed $sCRUD = 'read', mixed $iUserID = null) : bool

Arguments

$sPermission

string

string Name of the permission - see function getGlobalPermissions

$sCRUD

mixed

string The permission detailsyou want to check on: 'create','read','update','delete','import' or 'export'

$iUserID

mixed

integer User ID - if not given the one of the current user is used

Response

bool

True if user has the permission

Checks if a user has a certain permission in the given survey

hasSurveyPermission(mixed $iSurveyID, mixed $sPermission, mixed $sCRUD = 'read', mixed $iUserID = null) : bool

Arguments

$iSurveyID

mixed

integer The survey ID

$sPermission

mixed

string Name of the permission

$sCRUD

mixed

string The permission detail you want to check on: 'create','read','update','delete','import' or 'export'

$iUserID

mixed

integer User ID - if not given the one of the current user is used

Response

bool

True if user has the permission

Returns true if a user has permission to read/create/update a certain template

hasTemplatePermission($sTemplateName, mixed $sCRUD = 'read', mixed $iUserID = null) : bool

Arguments

$sTemplateName

$sCRUD

mixed

string The permission detailsyou want to check on: 'create','read','update','delete','import' or 'export'

$iUserID

mixed

integer User ID - if not given the one of the current user is used

Response

bool

True if user has the permission

function used to order Permission by language string

comparePermissionTitle($aApermission, $aBpermission) : integer
static

Arguments

$aApermission

$aBpermission

Response

integer

get the default/fixed $iUserID

getUserId($iUserID = null) : integer

Arguments

$iUserID

Response

integer

user id

get the owner if of an entity if exist

getOwnerId($iEntityID, $sEntityName) : integer|null

Arguments

$iEntityID

$sEntityName

Response

integer|null

user id if exist

Lists the behaviors of this model

behaviors() : array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior \PluginEventBehavior

Response

array

Modified version that default to do the same as the original, but allows via a third parameter to retrieve the result as array instead of active records. This solves a joining problem. Usage via findAllAsArray method

query(\CDbCriteria $criteria, boolean $all = false, $asAR = true) : mixed
inherited

Performs the actual DB query and populates the AR objects with the query result. This method is mainly internally used by other AR query methods.

since 1.1.7

Arguments

$criteria

\CDbCriteria

the query criteria

$all

boolean

whether to return all data

$asAR

Response

mixed

the AR objects populated with the query result

Finds all active records satisfying the specified condition but returns them as array

findAllAsArray(mixed $condition = '', array $params = array()) : array
inherited

See {@link find()} for detailed explanation about $condition and $params.

Arguments

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

array

list of active records satisfying the specified condition. An empty array is returned if none is found.

Return the max value for a field

getMaxId(string $field = null, boolean $forceRefresh = false) : false|int
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|int

Return the min value for a field

getMinId(string $field = null, boolean $forceRefresh = false) : false|int
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|int

deleteAllByAttributes

deleteAllByAttributes(array $attributes, mixed $condition = '', array $params = array()) : integer
inherited
todo

This should also be moved to the behavior at some point. This method overrides the parent in order to raise PluginEvents for Bulk delete operations. Filter Criteria are wrapped into a CDBCriteria instance so we have a single instance responsible for holding the filter criteria to be passed to the PluginEvent, this also enables us to pass the fully configured CDBCriteria instead of the original Parameters. See {@link find()} for detailed explanation about $condition and $params.

Arguments

$attributes

array

list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

number of rows affected by the execution.