Elgg
Version 4.3
|
User capabilities service. More...
Public Member Functions | |
__construct (PluginHooksService $hooks, EntityTable $entities, ElggSession $session) | |
Constructor. More... | |
canBypassPermissionsCheck ($user_guid=0) | |
Decides if the access system should be ignored for a user. More... | |
canEdit (ElggEntity $entity, $user_guid=0) | |
Can a user edit this entity? More... | |
canDelete (ElggEntity $entity, $user_guid=0) | |
Can a user delete this entity? More... | |
canDeleteRiverItem (ElggRiverItem $item, $user_guid=0) | |
Can a user delete this river item? More... | |
canEditAnnotation (ElggEntity $entity, $user_guid=0, ElggAnnotation $annotation=null) | |
Determines whether or not the user can edit this annotation. More... | |
canWriteToContainer (ElggEntity $entity, string $type, string $subtype, int $user_guid=0) | |
Can a user add an entity to this container. More... | |
canComment (ElggEntity $entity, $user_guid=0, $default=null) | |
Can a user comment on an entity? More... | |
canAnnotate (ElggEntity $entity, $user_guid=0, $annotation_name= '') | |
Can a user annotate an entity? More... | |
canDownload (ElggFile $entity, $user_guid=0, $default=true) | |
Can a user download a file? More... | |
User capabilities service.
Definition at line 20 of file UserCapabilities.php.
Elgg\UserCapabilities::__construct | ( | PluginHooksService | $hooks, |
EntityTable | $entities, | ||
ElggSession | $session | ||
) |
Constructor.
PluginHooksService | $hooks | Plugin hooks service |
EntityTable | $entities | Entity table |
ElggSession | $session | Session |
Definition at line 44 of file UserCapabilities.php.
Elgg\UserCapabilities::canAnnotate | ( | ElggEntity | $entity, |
$user_guid = 0 , |
|||
$annotation_name = '' |
|||
) |
Can a user annotate an entity?
Can be overridden by registering for the plugin hook [permissions_check:annotate:<name>, <entity type>="">] or [permissions_check:annotate, <entity type>="">]. The hooks are called in that order.
If you want logged out users to annotate an object, do not call canAnnotate(). It's easier than using the plugin hook.
ElggEntity | $entity | Objet entity |
int | $user_guid | User guid (default is logged in user) |
string | $annotation_name | The name of the annotation (default is unspecified) |
Definition at line 349 of file UserCapabilities.php.
Elgg\UserCapabilities::canBypassPermissionsCheck | ( | $user_guid = 0 | ) |
Decides if the access system should be ignored for a user.
Returns true (meaning ignore access) if either of these 2 conditions are true: 1) an admin user guid is passed to this function. 2) elgg_get_ignore_access() returns true.
int | $user_guid | The user to check against. |
Definition at line 61 of file UserCapabilities.php.
Elgg\UserCapabilities::canComment | ( | ElggEntity | $entity, |
$user_guid = 0 , |
|||
$default = null |
|||
) |
Can a user comment on an entity?
Can be overridden by registering for the permissions_check:comment, <entity type>=""> plugin hook.
ElggEntity | $entity | Object entity |
int | $user_guid | User guid (default is logged in user) |
bool | $default | Default permission |
Definition at line 306 of file UserCapabilities.php.
Elgg\UserCapabilities::canDelete | ( | ElggEntity | $entity, |
$user_guid = 0 |
|||
) |
Can a user delete this entity?
Can be overridden by registering for the permissions_check:delete plugin hook.
ElggEntity | $entity | Object entity |
int | $user_guid | The user GUID, optionally (default: logged in user) |
Definition at line 144 of file UserCapabilities.php.
Elgg\UserCapabilities::canDeleteRiverItem | ( | ElggRiverItem | $item, |
$user_guid = 0 |
|||
) |
Can a user delete this river item?
Can be overridden by registering for the "permissions_check:delete", "river" plugin hook.
ElggRiverItem | $item | River item |
int | $user_guid | The user GUID, optionally (default: logged in user) |
Definition at line 175 of file UserCapabilities.php.
Elgg\UserCapabilities::canDownload | ( | ElggFile | $entity, |
$user_guid = 0 , |
|||
$default = true |
|||
) |
Can a user download a file?
Can be overridden by registering for the permissions_check:download,file plugin hook.
ElggFile | $entity | File entity |
int | $user_guid | User guid (default is logged in user) |
bool | $default | Default permission |
Definition at line 393 of file UserCapabilities.php.
Elgg\UserCapabilities::canEdit | ( | ElggEntity | $entity, |
$user_guid = 0 |
|||
) |
Can a user edit this entity?
Can be overridden by registering for the permissions_check plugin hook.
ElggEntity | $entity | Object entity |
int | $user_guid | The user GUID, optionally (default: logged in user) |
Definition at line 87 of file UserCapabilities.php.
Elgg\UserCapabilities::canEditAnnotation | ( | ElggEntity | $entity, |
$user_guid = 0 , |
|||
ElggAnnotation | $annotation = null |
||
) |
Determines whether or not the user can edit this annotation.
Elggentity | $entity | Object entity |
int | $user_guid | The GUID of the user (defaults to currently logged in user) |
ElggAnnotation | $annotation | Annotation |
Definition at line 202 of file UserCapabilities.php.
Elgg\UserCapabilities::canWriteToContainer | ( | ElggEntity | $entity, |
string | $type, | ||
string | $subtype, | ||
int | $user_guid = 0 |
||
) |
Can a user add an entity to this container.
ElggEntity | $entity | Container entity |
string | $type | The type of entity we're looking to write |
string | $subtype | The subtype of the entity we're looking to write |
int | $user_guid | The GUID of the user creating the entity (0 for logged in user). |
Definition at line 251 of file UserCapabilities.php.