class BoardInstanceResponse extends Response (View source)

Properties

protected ObjectInterface $object from  Response
protected Category $category from  Response
static $cache from  Response

Methods

setPermissionObject(ObjectInterface $object)

Sets the current permission object to the object provided, this object should implement the Permission ObjectInterface.

from  Response
getPermissionObject()

Retrieves the current permission object.

from  Response
setPermissionCategoryObject(Category $category)

Sets the current Permission Category object to an appropriate PermissionKeyCategory.

from  Response
bool|int
testForErrors()

Returns an error constant if an error is present, false if there are no errors.

from  Response
static Response
getResponse(ObjectInterface $object)

Passing in any object that implements the ObjectInterface, retrieve the Permission Response object.

from  Response
bool
validate(string $permissionHandle, array $args = array())

This function returns true if the user has permission to the object, or false if they do not have access.

from  Response
__call($f, $a)

No description

from  Response
bool
canEditBoardInstanceSlot(int $slot)

Checks the current slot as well as the current time. If the slot is locked, it uses the canEditLockedRules command, otherwise it just uses canEditBoardContents(). However in both cases if the timestamp of the rule in the slot is in the future or ends in the past, we disregard the rule.

Details

setPermissionObject(ObjectInterface $object)

Sets the current permission object to the object provided, this object should implement the Permission ObjectInterface.

Parameters

ObjectInterface $object

getPermissionObject()

Retrieves the current permission object.

setPermissionCategoryObject(Category $category)

Sets the current Permission Category object to an appropriate PermissionKeyCategory.

Parameters

Category $category

bool|int testForErrors()

Returns an error constant if an error is present, false if there are no errors.

Return Value

bool|int

static Response getResponse(ObjectInterface $object)

Passing in any object that implements the ObjectInterface, retrieve the Permission Response object.

Parameters

ObjectInterface $object

Return Value

Response

bool validate(string $permissionHandle, array $args = array())

This function returns true if the user has permission to the object, or false if they do not have access.

Parameters

string $permissionHandle

A Permission Key Handle

array $args

Arguments to pass to the PermissionKey object's validate function

Return Value

bool

Exceptions

Exception

__call($f, $a)

No description

Parameters

$f
$a

bool canEditBoardInstanceSlot(int $slot)

Checks the current slot as well as the current time. If the slot is locked, it uses the canEditLockedRules command, otherwise it just uses canEditBoardContents(). However in both cases if the timestamp of the rule in the slot is in the future or ends in the past, we disregard the rule.

Parameters

int $slot

Return Value

bool