class PageResponse 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.

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
canWrite()

No description

canReadVersions()

No description

canRead()

No description

canAddSubContent()

No description

canViewPageInSitemap()

No description

canViewPage()

No description

canAddSubpages()

No description

canDeleteCollection()

No description

canEditPageType()

No description

canApproveCollection()

No description

canAdminPage()

No description

canAdmin()

No description

canAddExternalLink()

No description

canAddSubCollection($ct)

No description

canAddBlockType($bt)

No description

canEditPageProperties($obj = false)

No description

canDeletePage()

No description

canViewToolbar()

No description

getAllAssignmentsForPage()

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)

No description

Parameters

$f
$a

canWrite()

No description

canReadVersions()

No description

canRead()

No description

canAddSubContent()

No description

canViewPageInSitemap()

No description

canViewPage()

No description

canAddSubpages()

No description

canDeleteCollection()

No description

canEditPageType()

No description

canApproveCollection()

No description

canAdminPage()

No description

canAdmin()

No description

No description

canAddSubCollection($ct)

No description

Parameters

$ct

canAddBlockType($bt)

No description

Parameters

$bt

canEditPageProperties($obj = false)

No description

Parameters

$obj

canDeletePage()

No description

canViewToolbar()

No description

getAllTimedAssignmentsForPage()

No description

getAllAssignmentsForPage()

No description