1. interface
  2. SilverStripe
  3. \
  4. Security
  5. \
  6. PermissionChecker

PermissionChecker

interface PermissionChecker

Calculates edit / view / delete permissions for one or more objects

Methods

array
canEditMultiple(array $ids, Member $member = null, bool $useCached = true)

Get the 'can edit' information for a number of SiteTree pages.

mixed
canViewMultiple(array $ids, Member $member = null, bool $useCached = true)

Get the canView information for a number of objects

array
canDeleteMultiple(array $ids, Member $member = null, bool $useCached = true)

Get the 'can edit' information for a number of SiteTree pages.

bool
canDelete(int $id, Member $member = null)

Check delete permission for a single record ID

bool
canEdit(int $id, Member $member = null)

Check edit permission for a single record ID

bool
canView(int $id, Member $member = null)

Check view permission for a single record ID

Details

at line 20
array canEditMultiple(array $ids, Member $member = null, bool $useCached = true)

Get the 'can edit' information for a number of SiteTree pages.

Parameters

array $ids An array of IDs of the objects to look up
Member $member Member object
bool $useCached Return values from the permission cache if they exist

Return Value

array A map where the IDs are keys and the values are booleans stating whether the given object can be edited

at line 30
mixed canViewMultiple(array $ids, Member $member = null, bool $useCached = true)

Get the canView information for a number of objects

Parameters

array $ids
Member $member
bool $useCached

Return Value

mixed

at line 40
array canDeleteMultiple(array $ids, Member $member = null, bool $useCached = true)

Get the 'can edit' information for a number of SiteTree pages.

Parameters

array $ids An array of IDs of the objects pages to look up
Member $member Member object
bool $useCached Return values from the permission cache if they exist

Return Value

array

at line 49
bool canDelete(int $id, Member $member = null)

Check delete permission for a single record ID

Parameters

int $id
Member $member

Return Value

bool

at line 58
bool canEdit(int $id, Member $member = null)

Check edit permission for a single record ID

Parameters

int $id
Member $member

Return Value

bool

at line 67
bool canView(int $id, Member $member = null)

Check view permission for a single record ID

Parameters

int $id
Member $member

Return Value

bool