[phpdoc] Add API documentation.

This is a starting point to add a documentation of the whole set of APIs and
classes of Predis. The next step will be to actually improve and extend it.
This commit is contained in:
Daniele Alessandri
2011-10-18 17:55:58 +02:00
parent 1f2104ef7f
commit 4e6ed3f26d
210 changed files with 3818 additions and 48 deletions
+15
View File
@@ -11,14 +11,29 @@
namespace Predis;
/**
* Exception class that identifies server-side Redis errors.
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
class ServerException extends PredisException implements IRedisServerError
{
/**
* Gets the type of the error returned by Redis.
*
* @return string
*/
public function getErrorType()
{
list($errorType, ) = explode(' ', $this->getMessage(), 2);
return $errorType;
}
/**
* Converts the exception to an instance of ResponseError.
*
* @return ResponseError
*/
public function toResponseError()
{
return new ResponseError($this->getMessage());