Skip to content

Commit

Permalink
Fix phpdocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
terabytesoftw committed Oct 23, 2023
1 parent 09ef6e1 commit bc68a9a
Show file tree
Hide file tree
Showing 8 changed files with 80 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/ActiveQuery.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use yii\base\Component;
Expand Down Expand Up @@ -64,6 +71,9 @@
* If a relation involves a junction table, it may be specified by [[via()]].
* This methods may only be called in a relational context. Same is true for [[inverseOf()]], which
* marks a relation as inverse of another relation.
*
* @author Carsten Brandt <[email protected]>
* @since 2.0
*/
class ActiveQuery extends Component implements ActiveQueryInterface
{
Expand Down
10 changes: 10 additions & 0 deletions src/ActiveRecord.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use Yii;
Expand Down Expand Up @@ -29,6 +36,9 @@
* }
* }
* ```
*
* @author Carsten Brandt <[email protected]>
* @since 2.0
*/
class ActiveRecord extends BaseActiveRecord
{
Expand Down
10 changes: 10 additions & 0 deletions src/Cache.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use Yii;
Expand Down Expand Up @@ -91,6 +98,9 @@
* ~~~
*
* @property bool $isCluster Whether redis is running in cluster mode or not.
*
* @author Carsten Brandt <[email protected]>
* @since 2.0
*/
class Cache extends \yii\caching\Cache
{
Expand Down
10 changes: 10 additions & 0 deletions src/Connection.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use yii\base\Component;
Expand Down Expand Up @@ -240,6 +247,9 @@
* @property bool $isActive Whether the DB connection is established.
* @property LuaScriptBuilder $luaScriptBuilder
* @property false|resource $socket
*
* @author Carsten Brandt <[email protected]>
* @since 2.0
*/
class Connection extends Component
{
Expand Down
10 changes: 10 additions & 0 deletions src/LuaScriptBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use yii\base\InvalidArgumentException;
Expand All @@ -11,6 +18,9 @@

/**
* LuaScriptBuilder builds lua scripts used for retrieving data from redis.
*
* @author Carsten Brandt <[email protected]>
* @since 2.0
*/
class LuaScriptBuilder extends \yii\base\BaseObject
{
Expand Down
11 changes: 11 additions & 0 deletions src/Mutex.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use Yii;
Expand Down Expand Up @@ -49,6 +56,10 @@
*
* @see \yii\mutex\Mutex
* @see https://redis.io/topics/distlock
*
* @author Sergey Makinen <[email protected]>
* @author Alexander Zhuravlev <[email protected]>
* @since 2.0.6
*/
class Mutex extends \yii\mutex\Mutex
{
Expand Down
10 changes: 10 additions & 0 deletions src/Session.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use Yii;
Expand Down Expand Up @@ -47,6 +54,9 @@
* ~~~
*
* @property bool $useCustomStorage Whether to use custom storage.
*
* @author Carsten Brandt <[email protected]>
* @since 2.0
*/
class Session extends \yii\web\Session
{
Expand Down
9 changes: 9 additions & 0 deletions src/SocketException.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,21 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\redis;

use yii\db\Exception;

/**
* SocketException indicates a socket connection failure in [[Connection]].
*
* @since 2.0.7
*/
class SocketException extends Exception
{
Expand Down

0 comments on commit bc68a9a

Please sign in to comment.