phpstorm-stubs/yar/yar.php

149 lines
4.5 KiB
PHP

<?php
/**
* Class Yar_Server
* Date 2018/6/9 下午3:02
* @Author weizhimiao001@lianjia.com
* @link https://secure.php.net/manual/en/class.yar-server.php
*/
class Yar_Server {
protected $_executor ;
/**
* Register a server
* Set up a Yar HTTP RPC Server, All the public methods of $obj will be register as a RPC service.
*
* Yar_Server constructor.
* @param $obj object An Object, all public methods of its will be registered as RPC services.
* @link https://secure.php.net/manual/en/yar-server.construct.php
*/
final public function __construct ($obj ) {}
/**
* Start RPC Server
* Start a RPC HTTP server, and ready for accpet RPC requests.
* Note:
* Usual RPC calls will be issued as HTTP POST requests.
* If a HTTP GET request is issued to the uri,
* the service information (commented section above) will be printed on the page
* @return boolean
* @link https://secure.php.net/manual/en/yar-server.handle.php
*/
public function handle () {}
}
class Yar_Client {
protected $_protocol ;
protected $_uri ;
protected $_options ;
protected $_running ;
/**
* Call service
* Issue a call to remote RPC method.
*
* @param $method string Remote RPC method name.
* @param $parameters array Parameters.
* @link https://secure.php.net/manual/en/yar-client.call.php
*/
public function __call ( $method , $parameters ){}
/**
* Create a client
* Yar_Client constructor.
* @param $url string Yar Server URL.
* @link https://secure.php.net/manual/en/yar-client.construct.php
*/
final public function __construct ( $url ){}
/**
* Set calling contexts
*
* @param $name int it can be:
* - YAR_OPT_PACKAGER,
* - YAR_OPT_PERSISTENT (Need server support),
* - YAR_OPT_TIMEOUT,
* - YAR_OPT_CONNECT_TIMEOUT
* - YAR_OPT_HEADER (Since 2.0.4)
* @param $value
* @return object Returns $this on success or FALSE on failure.
* @link https://secure.php.net/manual/en/yar-client.setopt.php
*/
public function setOpt ($name , $value ){}
}
class Yar_Concurrent_Client {
static $_callstack ;
static $_callback ;
static $_error_callback ;
/**
* Register a concurrent call
* @param $uri string The RPC server URI(http, tcp)
* @param $method string Service name(aka the method name)
* @param $parameters array Parameters
* @param array ...$callback A function callback, which will be called while the response return.
* @return int
* @link https://secure.php.net/manual/en/yar-concurrent-client.call.php
*/
public static function call ( $uri , $method , $parameters, ...$callback ){}
/**
* Send all calls
* @param $callback
* If this callback is set, then Yar will call this callback after all calls are sent and before any response return, with a $callinfo NULL.
* Then, if user didn't specify callback when registering concurrent call, this callback will be used to handle response, otherwise, the callback specified while registering will be used.
* @param $error_callback
* If this callback is set, then Yar will call this callback while error occurred.
* @return boolean
* @link https://secure.php.net/manual/en/yar-concurrent-client.loop.php
*/
public static function loop ($callback , $error_callback) {}
/**
* Clean all registered calls
* Clean all registered calls
* @return boolean
* @link https://secure.php.net/manual/en/yar-concurrent-client.reset.php
*/
public static function reset (){}
}
/**
* Class Yar_Server_Exception
* Date 2018/6/9 下午3:06
* @Author weizhimiao001@lianjia.com
* @link https://secure.php.net/manual/en/class.yar-server-exception.php
*/
class Yar_Server_Exception extends Exception {
protected $_type ;
/**
* Retrieve exception's type
* Get the exception original type threw by server
* @return string
* @link https://secure.php.net/manual/en/yar-server-exception.gettype.php
*/
public function getType (){}
}
/**
* Class Yar_Client_Exception
* Date 2018/6/9 下午3:05
* @Author weizhimiao001@lianjia.com
* @link https://secure.php.net/manual/en/class.yar-client-exception.php
*/
class Yar_Client_Exception extends Exception {
/**
* Retrieve exception's type
* @return string "Yar_Exception_Client".
* @link https://secure.php.net/manual/en/yar-client-exception.gettype.php
*/
public function getType (){}
}