class AreaResponse extends Response (View source)

Properties

protected ObjectInterface $object from Response
protected PermissionKeyCategory $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(PermissionKeyCategory $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
canRead()

No description

canWrite()

No description

canAdmin()

No description

canAddBlocks()

No description

canAddStacks()

No description

canAddStack()

No description

canAddLayout()

No description

bool
canAddBlock(BlockType|Block $blockTypeOrBlock)

Check if a new block can be added to the area, or if an existing block can be moved to it.

canViewAreaControls()

No description

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(PermissionKeyCategory $category)

Sets the current Permission Category object to an appropriate PermissionKeyCategory.

Parameters

PermissionKeyCategory $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)

Parameters

$f
$a

canRead()

canWrite()

canAdmin()

canAddBlocks()

canAddStacks()

canAddStack()

canAddLayout()

bool canAddBlock(BlockType|Block $blockTypeOrBlock)

Check if a new block can be added to the area, or if an existing block can be moved to it.

Parameters

BlockType|Block $blockTypeOrBlock specify a block type when adding a new block, a block instance when adding an existing block.

Return Value

bool

canViewAreaControls()