PHP code example of hypejunction / hypecapabilities
1. Go to this page and download the library: Download hypejunction/hypecapabilities library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
hypejunction / hypecapabilities example snippets
\hypeJunction->register('role_name');
// Site wide role
elgg()->roles->assign('role_name', $user);
// Group specific role
elgg()->roles->assign('role_name', $user, $group);
// Site wide role
elgg()->roles->unassign('role_name', $user);
// Group specific role
elgg()->roles->unassign('role_name', $user, $group);
// Prevent users with given role from creating entities of a given type
elgg()->roles->role_name->onCreate('object', 'blog', Role::DENY);
// Allow users to create entities of a given type regardless of context
elgg()->roles->role_name->onCreate('object', 'blog', Role::ALLOW, Role::OVERRIDE);
// Allow users to create entities of a given type if all other container permissins are met
elgg()->roles->role_name->onCreate('object', 'blog', Role::ALLOW, Role::STACK);
// Allow users to create entities when specific conditions are met
// Only allow group blogs
elgg()->roles->role_name->onCreate('object', 'blog', Role::DENY, function(\hypeJunction\Capabilities\Context $context) {
$container = $context->getTarget();
if (!$container instanceof ElggGroup) {
return Role::DENY;
}
});
$params = [
'entity' => $entity,
'user' => $user,
];
if (!elgg_trigger_plugin_hook('permissions_check:administer', "$entity->type:$entity->subtype", $params, false)) {
// No permissions to approve
throw new EntityPermissionsException();
}
// Do something that
// Prevent users with given role from creating entities of a given type
// Allow moderator role to administer all blogs regardless of owner/container
elgg()->roles->moderator->onAdminister('object', 'blog', Role::ALLOW, Role::OVERRIDE);
// Allow users to create entities when specific conditions are met
// Allow teacher to administer all group blogs
elgg()->roles->teacher->canAdminister('object', 'blog', Role::ALLOW, function(\hypeJunction\Capabilities\Context $context) {
$entity = $context->getTarget();
$actor = $context->getActor();
$container = $entity->getContainerEntity();
return $container->canEdit($actor->guid);
});
// Context parameter contain matched route elements
// e.g. prevent access to user profile if users are not friends
elgg()->roles->user->onRouteAccess('view:user', Role::DENY, function(\hypeJunction\Capabilities\Context $context) {
$actor = $context->getActor();
$username = $context->getParam('username');
$user = get_user_by_username($username);
if (!$actor || !$user instanceof ElggUser || !$actor->isFriendOf($user->guid)) {
register_error('You must be friends to access user profiles');
return Role::DENY;
}
});
// Here is an example of how to prevent access to member pages to non-logged in users:
elgg()->roles->guest->onRouteAccess('collection:user:user', Role::DENY);
elgg()->roles->guest->onRouteAccess('collection:user:user:alpha', Role::DENY);
elgg()->roles->guest->onRouteAccess('collection:user:user:newest', Role::DENY);
elgg()->roles->guest->onRouteAccess('collection:user:user:online', Role::DENY);
elgg()->roles->guest->onRouteAccess('collection:user:user:popular', Role::DENY);
elgg()->roles->guest->onRouteAccess('search:user:user', Role::DENY);
elgg()->roles->guest->onRouteAccess('view:user', Role::DENY);
// Check a custom role
elgg()->roles->can('read', 'discussions');
// Define how role responds to capability check
elgg()->roles->guest->on('read', 'discussions', Role::DENY);
// Override role response
elgg_register_plugin_hook_handler('capability', 'read:discussions', function(Hook $hook) {
});
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.