Class Hooks

Namespace: Icybee\Modules\Users
Located at vendor/icanboogie-modules/users/lib/hooks.php

Methods summary

`public static`	# `before_roles_delete( ICanBoogie\Operation\BeforeProcessEvent $event, Icybee\Modules\Users\Roles\DeleteOperation $operation )` Checks if the role to be deleted is used or not. Checks if the role to be deleted is used or not. Parameters `$event` `BeforeProcessEvent` $event `$operation` `Icybee\Modules\Users\Roles\DeleteOperation` $operation
`public static`	# `on_security_exception_rescue( ICanBoogie\Exception\RescueEvent $event, ICanBoogie\SecurityException $target )` Displays a login form on `ICanBoogie\SecurityException`. Displays a login form on `ICanBoogie\SecurityException`. Parameters `$event` `ICanBoogie\Exception\RescueEvent` $event `$target` `ICanBoogie\SecurityException` $target
`public static`	# `on_website_admin_not_accessible_rescue( ICanboogie\Exception\RescueEvent $event, Icybee\Modules\Users\WebsiteAdminNotAccessible $target )` Displays an _available websites_ form on `Icybee\Modules\Users\WebsiteAdminNotAccessible`. Displays an _available websites_ form on `Icybee\Modules\Users\WebsiteAdminNotAccessible`. Parameters `$event` `ICanboogie\Exception\RescueEvent` $event `$target` `Icybee\Modules\Users\WebsiteAdminNotAccessible` $target
`public static`	# `before_routing_dispatcher_dispatch( ICanBoogie\Routing\Dispatcher\BeforeDispatchEvent $event, ICanBoogie\Routing\Dispatcher $target )` The `ICanBoogie\PermissionRequired` exception is thrown if a member attempts to enter the admin. The `ICanBoogie\PermissionRequired` exception is thrown if a member attempts to enter the admin. Authenticated users who don't have access to the admin of a website are redirected to the `/admin/pofile/sites` URL, in which case the `response` property of the event is altered with a `ICanBoogie\HTTP\RedirectResponse`. Parameters `$event` `ICanBoogie\HTTP\Dispatcher\BeforeDispatchEvent` $event `$target` `ICanBoogie\HTTP\Dispatcher` $target Throws `ICanBoogie\PermissionRequired` if a member attempt to enter the admin. `Icybee\Modules\Users\WebsiteAdminNotAccessible` if a user attempts to access the admin of a website he doesn't have access to.
`public static`	# `on_login( ICanBoogie\Operation\ProcessEvent $event, Icybee\Modules\Users\LoginOperation $target )` Adds an info alert informing the user that the security was improved and he could benefit from it by entering its password again. Adds an info alert informing the user that the security was improved and he could benefit from it by entering its password again. Parameters `$event` `ICanBoogie\Operation\ProcessEvent` $event `$target` `Icybee\Modules\Users\LoginOperation` $target
`public static integer\|null`	# `get_user_id( ICanBoogie\Core $core )` Returns the user's identifier. Returns the user's identifier. This is the getter for the `$core->user_id` property. Parameters `$core` `ICanBoogie\Core` $core Returns `integer\|null` Returns the identifier of the user or null if the user is a guest. See `Icybee\Modules\Users\User::login()`
`public static Icybee\Modules\Users\User`	# `get_user( ICanBoogie\Core $core )` Returns the user object. Returns the user object. If the user identifier can be retrieved from the session, it is used to find the corresponding user. If no user could be found, a guest user object is returned. This is the getter for the `$core->user` property. Parameters `$core` `ICanBoogie\Core` $core Returns `Icybee\Modules\Users\User` The user object, or guest user object.
`public static Icybee\Modules\Users\PermissionResolver`	# `get_user_permission_resolver( ICanBoogie\Core $core )` Returns a user permission resolver configurer with the `users` config. Returns a user permission resolver configurer with the `users` config. Parameters `$core` `ICanBoogie\Core` $core Returns `Icybee\Modules\Users\PermissionResolver`
`public static Icybee\Modules\Users\OwnershipResolver`	# `get_user_ownership_resolver( ICanBoogie\Core $core )` Returns a user permission resolver configurer with the `users` config. Returns a user permission resolver configurer with the `users` config. Parameters `$core` `ICanBoogie\Core` $core Returns `Icybee\Modules\Users\OwnershipResolver`
`public static`	# `check_user_permission( ICanBoogie\Core $core, Icybee\Modules\Users\User $user, string $permission, string $target = null )` Checks if a user has a given permission. Checks if a user has a given permission. Parameters `$core` `ICanBoogie\Core` $core `$user` `Icybee\Modules\Users\User` $user `$permission` `string` $permission `$target` `string` $target
`public static`	# `check_user_ownership( ICanBoogie\Core $core, Icybee\Modules\Users\User $user, ICanBoogie\ActiveRecord $record )` Checks if a user has the ownership of a record. Checks if a user has the ownership of a record. Parameters `$core` `ICanBoogie\Core` $core `$user` `Icybee\Modules\Users\User` $user `$record` `ICanBoogie\ActiveRecord` $record
`public static boolean\|null`	# `resolve_user_ownership( Icybee\Modules\Users\User $user, ICanBoogie\ActiveRecord $record )` Resolves user ownership of a record. Resolves user ownership of a record. Parameters `$user` `Icybee\Modules\Users\User` $user `$record` `ICanBoogie\ActiveRecord` $record Returns `boolean\|null` `true` if the user identifier is 1, or the `uid` property of the record is not empty and it matches the user identifier. `null` otherwise.
`public static`	# `markup_form_login( array $args, mixed $engine, mixed $template )`
`public static`	# `markup_user( array $args, Patron\Engine $engine, array $template )` Retrieves the current user. Retrieves the current user. <p:user> <!-- Content: with-param*, template --> </p:user> Parameters `$args` `array` $args `$engine` `Patron\Engine` $engine `$template` `array` $template

Magic methods summary