Visibility_Interface
Tags
Table of Contents
- correct_password_entered() : bool
- Is the correct password entered?
- current_user_allowed_by_id() : bool
- Is the current user allowed access to this object by ID?
- current_user_allowed_by_role() : bool
- Is the current user allowed access to this object by role?
- get_data_object() : object
- Retrieve the object.
- get_object_id() : int
- Retrieve the object id.
- get_object_type() : string
- Retrieve the object type.
- get_passwords() : array<string|int, mixed>
- Get the passwords for this item.
- get_roles() : array<string|int, mixed>
- Get the roles for this item.
- get_users() : array<string|int, mixed>
- Get the users for this item.
- get_visibility() : string
- Get the visibility level.
- has_password_protection() : bool
- Check if this item has password protection.
- has_protection() : bool
- Check if this item has any form of protection.
- has_role_protection() : bool
- Check if this item has role protection.
- has_user_protection() : bool
- Check if this item has user protection.
- initialize_visbility_data() : mixed
- Initialize the visibility data.
- is_hidden() : bool
- Check if this item is hidden.
- is_password_protected() : bool
- Check if this item is password protected.
- is_protected() : bool
- Check if this item is protected.
- is_public() : bool
- Check if this item is public.
- is_role_protected() : bool
- Check if this item is role protected.
- is_unlocked() : bool
- Check if this item is unlocked.
- is_unlocked_by_password() : bool
- Check if this item is unlocked by password.
- is_unlocked_by_role() : bool
- Check if this item is unlocked by role.
- is_unlocked_by_user() : bool
- Check if this item is unlocked by user.
- is_user_protected() : bool
- Check if this item is user protected.
Methods
correct_password_entered()
Is the correct password entered?
public
correct_password_entered() : bool
Tags
Return values
bool —current_user_allowed_by_id()
Is the current user allowed access to this object by ID?
public
current_user_allowed_by_id() : bool
Tags
Return values
bool —true if the current user is allowed access.
current_user_allowed_by_role()
Is the current user allowed access to this object by role?
public
current_user_allowed_by_role() : bool
Tags
Return values
bool —true if the current user is allowed access.
get_data_object()
Retrieve the object.
public
get_data_object() : object
Tags
Return values
object —get_object_id()
Retrieve the object id.
public
get_object_id() : int
Tags
Return values
int —get_object_type()
Retrieve the object type.
public
get_object_type() : string
Tags
Return values
string —get_passwords()
Get the passwords for this item.
public
get_passwords() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array of passwords
get_roles()
Get the roles for this item.
public
get_roles() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array of roles
get_users()
Get the users for this item.
public
get_users() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array of users
get_visibility()
Get the visibility level.
public
get_visibility() : string
Tags
Return values
string —The visibility level
has_password_protection()
Check if this item has password protection.
public
has_password_protection() : bool
Tags
Return values
bool —true if password protected, false otherwise
has_protection()
Check if this item has any form of protection.
public
has_protection() : bool
Tags
Return values
bool —true if protected, false otherwise
has_role_protection()
Check if this item has role protection.
public
has_role_protection() : bool
Tags
Return values
bool —true if role protected, false otherwise
has_user_protection()
Check if this item has user protection.
public
has_user_protection() : bool
Tags
Return values
bool —true if user protected, false otherwise
initialize_visbility_data()
Initialize the visibility data.
public
initialize_visbility_data() : mixed
Tags
Return values
mixed —is_hidden()
Check if this item is hidden.
public
is_hidden() : bool
Tags
Return values
bool —true if hidden, false otherwise
is_password_protected()
Check if this item is password protected.
public
is_password_protected() : bool
Tags
Return values
bool —true if password protected, false otherwise
is_protected()
Check if this item is protected.
public
is_protected() : bool
Tags
Return values
bool —true if protected, false otherwise
is_public()
Check if this item is public.
public
is_public() : bool
Tags
Return values
bool —true if public, false otherwise
is_role_protected()
Check if this item is role protected.
public
is_role_protected() : bool
Tags
Return values
bool —true if role protected, false otherwise
is_unlocked()
Check if this item is unlocked.
public
is_unlocked() : bool
Tags
Return values
bool —true if unlocked, false otherwise
is_unlocked_by_password()
Check if this item is unlocked by password.
public
is_unlocked_by_password() : bool
Tags
Return values
bool —true if unlocked by password, false otherwise
is_unlocked_by_role()
Check if this item is unlocked by role.
public
is_unlocked_by_role() : bool
Tags
Return values
bool —true if unlocked by role, false otherwise
is_unlocked_by_user()
Check if this item is unlocked by user.
public
is_unlocked_by_user() : bool
Tags
Return values
bool —true if unlocked by user, false otherwise
is_user_protected()
Check if this item is user protected.
public
is_user_protected() : bool
Tags
Return values
bool —true if user protected, false otherwise