AccessList

• Full name: \Zotlabs\Access\AccessList

Constants

Constant	Visibility	Type	Value
REQUIRED_KEYS_CONSTRUCTOR	private		['channel_allow_cid', 'channel_allow_gid', 'channel_deny_cid', 'channel_deny_gid']
REQUIRED_KEYS_SET	private		['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid']

Properties

allow_cid

private string $allow_cid

---

allow_gid

private string $allow_gid

---

deny_cid

private string $deny_cid

---

deny_gid

private string $deny_gid

---

explicit

private bool $explicit

---

Methods

__construct

public __construct(array $channel): mixed

Parameters:

Parameter	Type	Description
$channel	array	A channel array, where these entries are evaluated: \e string \b channel_allow_cid => string of allowed cids \e string \b channel_allow_gid => string of allowed gids \e string \b channel_deny_cid => string of denied cids \e string \b channel_deny_gid => string of denied gids

---

validate_input_array

private validate_input_array(array $arr, array $required_keys): void

Parameters:

Parameter	Type	Description
$arr	array
$required_keys	array

---

get_explicit

public get_explicit(): bool

---

set

public set(array $arr, bool $explicit = true): void

Parameters:

Parameter	Type	Description
$arr	array	* \e string \b allow_cid => string of allowed cids * \e string \b allow_gid => string of allowed gids * \e string \b deny_cid => string of denied cids * \e string \b deny_gid => string of denied gids
$explicit	bool	(optional) default true

---

get

public get(): array

Return Value:

An associative array with: * \e string \b allow_cid => string of allowed cids * \e string \b allow_gid => string of allowed gids * \e string \b deny_cid => string of denied cids * \e string \b deny_gid => string of denied gids

---

set_from_array

public set_from_array(array $arr, bool $explicit = true): void

Parameters:

Parameter	Type	Description
$arr	array	An associative array with: \e array|string \b contact_allow => array with cids or comma-seperated string \e array|string \b group_allow => array with gids or comma-seperated string \e array|string \b contact_deny => array with cids or comma-seperated string \e array|string \b group_deny => array with gids or comma-seperated string
$explicit	bool	(optional) default true

---

is_private

public is_private(): bool

Return Value:

Return true if any of allow_ deny_ values is set.

---

---

Automatically generated on 2025-03-19