inc\classes\Contacts.php

Show:

inherited

Classes
- \Contacts

Table of Contents

File with Contacts logic

No additional classes/funtions

Author: Sergey Dilong
License: GPL-2.0
Package: Temply-Account\Services

\Contacts
jump to top

Package: Temply-Account\Services

Contacts class

Get list of contacts who you can add to chats etc.

Author: Sergey Dilong
License: GPL-2.0

Methods

Add(integer $u, string | integer $q = "me", array $o = array()) : boolean

static

Add User to Contacts

Adds a user to requested contacts list

Parameters

Name	Type	Description
$u	integer	User ID to add
$q	string \| integer	Contacts list owner. If === `me` - works with current user
$o	array	Options

Returns

Type	Description
boolean

Throws

Exception	Description
\apiException	* [701] Incorrect ID * [702] User is already added

Details

Api

FindByID(integer $u, integer | string $q = "me", array $o = array()) : boolean

static

Find By ID

Search for a user in contacts list

Returns true if found such ID

Parameters

Name	Type	Description
$u	integer	Requested user
$q	integer \| string	Contacts ist owner. If === `me` - works with current user
$o	array	Options

Returns

Type	Description
boolean

Details

Api

Get(integer | string $q = "me", array $o = array(), array $u_o = array()) : \(User | array<mixed,\int)>

static

Get contacts

Get current user's (or by id) contacts

Parameters

Name	Type	Description
$q	integer \| string	Query. If === `me` - works with current user
$o	array	Options RETURN_IDS - Users will be returned as int ids instead of classes
$u_o	array	Options for User class

Returns

Type	Description
\(User \| array<mixed,\int)>

Throws

Exception	Description
\apiException	* [701] Incorrect query

Details

Api

Remove(integer $u, string | integer $q = "me") : boolean

static

Remove Contacts

Removes a contact from list

Not ready yet

Parameters

Name	Type	Description
$u	integer	User to remove
$q	string \| integer	Contacts ist owner. If === `me` - work with current user

Returns

Type	Description
boolean	Result

Throws

Exception	Description
\apiException	* [701] Incorrect typ * [703] No such user in contacts

Details

Api

inc\classes\Contacts.php

\Contactsjump to top

Methods

\Contacts
jump to top