Mibew/tray
1
0
Fork 0
mirror of https://github.com/Mibew/tray.git synced 2025-01-22 18:10:34 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix docs for UsersProcessor class

Browse Source
This commit is contained in:
Dmitriy Simushev 2013-02-13 09:18:06 +00:00
parent aaf3bafb02
commit 48cc52cf72
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/messenger/webim/libs/classes/users_processor.php
View File

@ -29,10 +29,6 @@
* - usersUpdateVisitorsLoad * - usersUpdateVisitorsLoad
* - usersUpdateVisitorsAlter * - usersUpdateVisitorsAlter
* *
* WARNING:
* usersResponseReceived registered but never called because of asynchronous
* nature of Core-to-Window interaction
*
* Implements Singleton pattern * Implements Singleton pattern
*/ */
class UsersProcessor extends ClientSideProcessor { class UsersProcessor extends ClientSideProcessor {
@ -44,7 +40,7 @@ class UsersProcessor extends ClientSideProcessor {
protected static $instance = null; protected static $instance = null;
/** /**
* Return an instance of the ThreadProcessor class. * Return an instance of the UsersProcessor class.
* @return UsersProcessor * @return UsersProcessor
*/ */
public static function getInstance() { public static function getInstance() {
@ -57,7 +53,8 @@ class UsersProcessor extends ClientSideProcessor {
/** /**
* Class constructor * Class constructor
* *
* Do not use directly __construct method! Use ThreadProcessor::getInstance() instead! * Do not use directly __construct method! Use UsersProcessor::getInstance()
* instead!
* @todo Think about why the method is not protected * @todo Think about why the method is not protected
*/ */
public function __construct() { public function __construct() {
@ -354,6 +351,7 @@ class UsersProcessor extends ClientSideProcessor {
* @param array $args Associative array of arguments. It must contains * @param array $args Associative array of arguments. It must contains
* following keys: * following keys:
* - 'agentId': Id of the agent related to users window * - 'agentId': Id of the agent related to users window
*
* @return array Array of results. It contains following keys: * @return array Array of results. It contains following keys:
* - 'visitors': array of visitors on the site * - 'visitors': array of visitors on the site
*/ */
@ -460,9 +458,11 @@ class UsersProcessor extends ClientSideProcessor {
* Return updated operators list. API function * Return updated operators list. API function
* *
* @global string $webim_encoding Encoding for the current locale * @global string $webim_encoding Encoding for the current locale
*
* @param array $args Associative array of arguments. It must contains * @param array $args Associative array of arguments. It must contains
* following keys: * following keys:
* - 'agentId': Id of the agent related to users window * - 'agentId': Id of the agent related to users window
*
* @return array Array of results. It contains following keys: * @return array Array of results. It contains following keys:
* - 'operators': array of online operators * - 'operators': array of online operators
*/ */
@ -514,8 +514,8 @@ class UsersProcessor extends ClientSideProcessor {
/** /**
* Update chat window state. API function * Update chat window state. API function
* Call periodically by chat window.
* *
* Call periodically by chat window
* @param array $args Associative array of arguments. It must contains * @param array $args Associative array of arguments. It must contains
* following keys: * following keys:
* - 'agentId': Id of the agent related to users window * - 'agentId': Id of the agent related to users window
@ -543,6 +543,7 @@ class UsersProcessor extends ClientSideProcessor {
* @param array $args Associative array of arguments. It must contains * @param array $args Associative array of arguments. It must contains
* following keys: * following keys:
* - 'agentId': Id of the agent related to users window * - 'agentId': Id of the agent related to users window
*
* @return array Array of results. It contains following keys: * @return array Array of results. It contains following keys:
* - 'time': current server time * - 'time': current server time
*/ */