LimeSurvey API - Master branch
Back to top  

Permission

Extends \LSActiveRecord

Class Permission

package

Default

Methods

Lists the behaviors of this model

behaviors() : array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior \PluginEventBehavior

Response

array

function used to order Permission by language string

comparePermissionTitle(array $aApermission, array $aBpermission) : integer
static

Arguments

$aApermission

array

The first permission information

$aBpermission

array

The second permission information

Response

integer

copySurveyPermissions

copySurveyPermissions(integer $iSurveyIDSource, integer $iSurveyIDTarget)

Arguments

$iSurveyIDSource

integer

$iSurveyIDTarget

integer

deleteAllByAttributes

deleteAllByAttributes(array $attributes, string $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

string

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

number of rows affected by the execution.

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

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

See \find() for detailed explanation about $condition and $params.

Arguments

$condition

\CDbCriteria

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.

Returns the global permissions including description and title

getGlobalBasePermissions() : array
static
access

public
static

Response

array

Return the max value for a field

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

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

Throws
\Exception

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|integer

Return the min value for a field

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

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

Throws
\Exception

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|integer

get the owner if of an entity if exist

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

Arguments

$iEntityID

integer

the entity id

$sEntityName

string

string name (model)

Response

integer|null

user id if exist

getPermissions

getPermissions(integer $iUserID, integer $iEntityID = null, string $sEntityName = null) : array
static

Arguments

$iUserID

integer

$iEntityID

integer

$sEntityName

string

Response

array

Returns the base permissions

getSurveyBasePermissions() : array
static
access

public
static

Response

array

getUserDetails

getUserDetails(integer $surveyid) : array

Arguments

$surveyid

integer

Response

array

get the default/fixed $iUserID

getUserId(integer $iUserID = null) : integer
static
Throws
\Exception

Arguments

$iUserID

integer

optional user id

Response

integer

user id

giveAllSurveyPermissions

giveAllSurveyPermissions(integer $iUserID, integer $iSurveyID)

Arguments

$iUserID

integer

$iSurveyID

integer

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

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

Arguments

$sPermission

string

string Name of the permission - see function getGlobalPermissions

$sCRUD

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

$iUserID

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

Response

boolean

True if user has the permission

Checks if a user has a certain permission

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

Arguments

$iEntityID

integer The entity ID

$sEntityName

string

string The entity name

$sPermission

string Name of the permission

$sCRUD

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

$iUserID

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

Response

boolean

True if user has the permission

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

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

Arguments

$iSurveyID

integer The survey ID

$sPermission

string Name of the permission

$sCRUD

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

$iUserID

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

Response

boolean

True if user has the permission

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

hasTemplatePermission(string $sTemplateName,  $sCRUD = 'read', integer $iUserID = null) : boolean

Arguments

$sTemplateName

string

$sCRUD

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

$iUserID

integer

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

Response

boolean

True if user has the permission

insertRecords

insertRecords(array $data)

Arguments

$data

array

insertSomeRecords

insertSomeRecords(array $data) : boolean

Arguments

$data

array

Response

boolean

Returns true if user is a forced superadmin (can not disable superadmin rights)

isForcedSuperAdmin( $iUserID) : boolean
static
var

Arguments

$iUserID

Response

boolean

Returns the static model of Settings table

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

public

Arguments

$class

string

Response

\Permission

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, boolean $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

boolean

Response

mixed

the AR objects populated with the query result

Set global permissions to the user id

setGlobalPermission(integer $iNewUID, string $sPermType, array<mixed,string> $aPermissions = array('read_p'))

Arguments

$iNewUID

integer

$sPermType

string

$aPermissions

array<mixed,string>

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) : null|boolean
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

Response

null|boolean

tableName

tableName()
inheritdoc

Properties

aGlobalBasePermissions

aGlobalBasePermissions :
static

Type(s)

id

id : integer

Type(s)

integer

entity

entity : string

Type(s)

string

entity_id

entity_id : integer

Type(s)

integer

uid

uid : integer

Type(s)

integer

permission

permission : string

Type(s)

string

create_p

create_p : integer

Type(s)

integer

read_p

read_p : integer

Type(s)

integer

update_p

update_p : integer

Type(s)

integer

import_p

import_p : integer

Type(s)

integer

export_p

export_p : integer

Type(s)

integer