Class yii\redis\Connection
| Inheritance | yii\ |
|---|---|
| Implements | yii\ |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-redis/blob/master/Connection.php |
The redis connection class is used to establish a connection to a redis server.
By default it assumes there is a redis server running on localhost at port 6379 and uses the database number 0.
It is possible to connect to a redis server using $hostname and $port or using a $unixSocket.
It also supports the AUTH command of redis. When the server needs authentication, you can set the $password property to authenticate with the server after connect.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | array<yii\ |
List of behaviors attached to this component. | yii\ |
| $connectionString | string | Socket connection string. | yii\ |
| $connectionTimeout | float | Timeout to use for connection to redis. | yii\ |
| $contextOptions | array | PHP context options which are used in the Redis connection stream. | yii\ |
| $dataTimeout | float | Timeout to use for redis socket when reading and writing data. | yii\ |
| $database | integer | The redis database to use. | yii\ |
| $driverName | string | Name of the DB driver. | yii\ |
| $hostname | string | The hostname or ip address to use for connecting to the redis server. | yii\ |
| $isActive | boolean | Whether the DB connection is established. | yii\ |
| $luaScriptBuilder | yii\ |
yii\ |
|
| $password | string | The password for establishing DB connection. | yii\ |
| $port | integer | The port to use for connecting to the redis server. | yii\ |
| $redirectConnectionString | string|null | If the query gets redirected, use this as the temporary new hostname | yii\ |
| $redisCommands | array | List of available redis commands. | yii\ |
| $retries | integer | The number of times a command execution should be retried when a connection failure occurs. | yii\ |
| $retryInterval | integer | The retry interval in microseconds to wait between retry. | yii\ |
| $scheme | string | The connection scheme used for connecting to the redis server. | yii\ |
| $socket | resource|false | yii\ |
|
| $socketClientFlags | integer | Bitmask field which may be set to any combination of connection flags passed to stream_socket_client(). | yii\ |
| $unixSocket | string | The unix socket path (e.g. /var/run/redis/redis.sock) to use for connecting to the redis server. |
yii\ |
| $useSSL | boolean | Send sockets over SSL protocol. | yii\ |
| $username | string|null | Username for establishing DB connection. | yii\ |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Allows issuing all supported commands via magic methods. | yii\ |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\ |
| __construct() | Constructor. | yii\ |
| __get() | Returns the value of a component property. | yii\ |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
| __set() | Sets the value of a component property. | yii\ |
| __sleep() | Closes the connection when this component is being serialized. | yii\ |
| __unset() | Sets a component property to be null. | yii\ |
| attachBehavior() | Attaches a behavior to this component. | yii\ |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\ |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\ |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
| className() | Returns the fully qualified name of this class. | yii\ |
| close() | Closes the currently active DB connection. | yii\ |
| detachBehavior() | Detaches a behavior from the component. | yii\ |
| detachBehaviors() | Detaches all behaviors from the component. | yii\ |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\ |
| executeCommand() | Executes a redis command. | yii\ |
| getBehavior() | Returns the named behavior object. | yii\ |
| getBehaviors() | Returns all behaviors attached to this component. | yii\ |
| getConnectionString() | Return the connection string used to open a socket connection. During a redirect (cluster mode) this will be the target of the redirect. | yii\ |
| getDriverName() | Returns the name of the DB driver for the current dsn. | yii\ |
| getIsActive() | Returns a value indicating whether the DB connection is established. | yii\ |
| getLuaScriptBuilder() | yii\ |
|
| getSocket() | Return the connection resource if a connection to the target has been established before, false otherwise. |
yii\ |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\ |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\ |
| init() | Initializes the object. | yii\ |
| off() | Detaches an existing event handler from this component. | yii\ |
| on() | Attaches an event handler to an event. | yii\ |
| open() | Establishes a DB connection. | yii\ |
| trigger() | Triggers an event. | yii\ |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| initConnection() | Initializes the DB connection. | yii\ |
| sendRawCommand() | Sends RAW command string to the server. | yii\ |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_OPEN | yii\redis\Event | An event that is triggered after a DB connection is established | yii\ |
Property Details
Timeout to use for connection to redis.
If not set the timeout set in php.ini will be used: ini_get("default_socket_timeout").
PHP context options which are used in the Redis connection stream.
Timeout to use for redis socket when reading and writing data.
If not set the php default value will be used.
The redis database to use.
This is an integer value starting from 0. Defaults to 0.
Since version 2.0.6 you can disable the SELECT command sent after connection by setting this property to null.
The hostname or ip address to use for connecting to the redis server.
Defaults to 'localhost'. If $unixSocket is specified, hostname and $port will be ignored.
The password for establishing DB connection.
Defaults to null meaning no AUTH command is sent. See https://redis.io/commands/auth
The port to use for connecting to the redis server.
Default port is 6379. If $unixSocket is specified, $hostname and port will be ignored.
If the query gets redirected, use this as the temporary new hostname
List of available redis commands.
See also https://redis.io/commands.
The number of times a command execution should be retried when a connection failure occurs.
This is used in executeCommand() when a yii\
The retry interval in microseconds to wait between retry.
This is used in executeCommand() when a yii\
The connection scheme used for connecting to the redis server.
Defaults to 'tcp'.
Bitmask field which may be set to any combination of connection flags passed to stream_socket_client().
Currently the select of connection flags is limited to STREAM_CLIENT_CONNECT (default), STREAM_CLIENT_ASYNC_CONNECT and STREAM_CLIENT_PERSISTENT.
Warning:
STREAM_CLIENT_PERSISTENTwill make PHP reuse connections to the same server. If you are using multiple connection objects to refer to different redis databases on the same $port, redis commands may get executed on the wrong database.STREAM_CLIENT_PERSISTENTis only safe to use if you use only one database.You may still use persistent connections in this case when disambiguating ports as described in a comment on the PHP manual e.g. on the connection used for session storage, specify the port as:
'port' => '6379/session'
See also https://www.php.net/manual/en/function.stream-socket-client.php.
Send sockets over SSL protocol.
Default state is false.
Method Details
Allows issuing all supported commands via magic methods.
$redis->hmset('test_collection', 'key1', 'val1', 'key2', 'val2')
| public __call( string $name, array $params ): mixed | ||
| $name | string |
Name of the missing method to execute |
| $params | array |
Method call arguments |
public function __call($name, $params)
{
$redisCommand = strtoupper(Inflector::camel2words($name, false));
if (in_array($redisCommand, $this->redisCommands)) {
return $this->executeCommand($redisCommand, $params);
}
return parent::__call($name, $params);
}
Defined in:
yii\
This method is called after the object is created by cloning an existing one.
It removes all behaviors because they are attached to the old object.
| public __clone( ): mixed |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
Defined in:
yii\
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$confighere. - call the parent implementation at the end of the constructor.
| public __construct( array<string, mixed> $config = [] ): mixed | ||
| $config | array<string, mixed> |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in:
yii\
Returns the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $component->property;.
See also __set().
| public __get( string $name ): mixed | ||
| $name | string |
The property name |
| return | mixed |
The property value or the value of a behavior's property |
|---|---|---|
| throws | yii\ |
if the property is not defined |
| throws | yii\ |
if the property is write-only. |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in:
yii\
Checks if a property is set, i.e. defined and not null.
This method will check in the following order and act accordingly:
- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return
falsefor non existing properties
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($component->property).
| public __isset( string $name ): boolean | ||
| $name | string |
The property name or the event name |
| return | boolean |
Whether the named property is set |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
Defined in:
yii\
Sets the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $component->property = $value;.
See also __get().
| public __set( string $name, mixed $value ): mixed | ||
| $name | string |
The property name or the event name |
| $value | mixed |
The property value |
| throws | yii\ |
if the property is not defined |
|---|---|---|
| throws | yii\ |
if the property is read-only. |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
if ($value instanceof Behavior) {
$this->attachBehavior($name, $value);
} elseif ($value instanceof \Closure) {
$this->attachBehavior($name, call_user_func($value));
} elseif (isset($value['__class']) && is_subclass_of($value['__class'], Behavior::class)) {
$this->attachBehavior($name, Yii::createObject($value));
} elseif (!isset($value['__class']) && isset($value['class']) && is_subclass_of($value['class'], Behavior::class)) {
$this->attachBehavior($name, Yii::createObject($value));
} elseif (is_string($value) && is_subclass_of($value, Behavior::class, true)) {
$this->attachBehavior($name, Yii::createObject($value));
} else {
throw new InvalidConfigException('Class is not of type ' . Behavior::class . ' or its subclasses');
}
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
Closes the connection when this component is being serialized.
| public __sleep( ): array |
public function __sleep()
{
$this->close();
return array_keys(get_object_vars($this));
}
Defined in:
yii\
Sets a component property to be null.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($component->property).
| public __unset( string $name ): mixed | ||
| $name | string |
The property name |
| throws | yii\ |
if the property is read only. |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
Defined in:
yii\
Attaches a behavior to this component.
This method will create the behavior object based on the given
configuration. After that, the behavior object will be attached to
this component by calling the yii\
See also detachBehavior().
| public attachBehavior( string $name, string|array|yii\ | ||
| $name | string |
The name of the behavior. |
| $behavior | string|array|yii\ |
The behavior configuration. This can be one of the following:
|
| return | yii\ |
The behavior object |
|---|---|---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in:
yii\
Attaches a list of behaviors to the component.
Each behavior is indexed by its name and should be a yii\
See also attachBehavior().
| public attachBehaviors( array $behaviors ): mixed | ||
| $behaviors | array |
List of behaviors to be attached to the component |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
Defined in:
yii\
Returns a list of behaviors that this component should behave as.
Child classes may override this method to specify the behaviors they want to behave as.
The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
Note that a behavior class must extend from yii\
Behaviors declared in this method will be attached to the component automatically (on demand).
| public behaviors( ): array<array-key, class-string|array{class: class-string}|yii\ | ||
| return | array<array-key, class-string|array{class: class-string}|yii\ |
The behavior configurations. |
|---|---|---|
public function behaviors()
{
return [];
}
Defined in:
yii\
Returns a value indicating whether a property can be read.
A property can be read if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true); - an attached behavior has a readable property of the given name (when
$checkBehaviorsis true).
See also canSetProperty().
| public canGetProperty( string $name, boolean $checkVars = true, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| $checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
| return | boolean |
Whether the property can be read |
|---|---|---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
Defined in:
yii\
Returns a value indicating whether a property can be set.
A property can be written if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true); - an attached behavior has a writable property of the given name (when
$checkBehaviorsis true).
See also canGetProperty().
| public canSetProperty( string $name, boolean $checkVars = true, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| $checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
| return | boolean |
Whether the property can be written |
|---|---|---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class instead.
Defined in:
yii\
Returns the fully qualified name of this class.
| public static className( ): string | ||
| return | string |
The fully qualified name of this class. |
|---|---|---|
public static function className()
{
return get_called_class();
}
Closes the currently active DB connection.
It does nothing if the connection is already closed.
| public close( ): void |
public function close(): void
{
foreach ($this->_pool as $socket) {
$connection = $this->connectionString . ', database=' . $this->database;
\Yii::debug('Closing DB connection: ' . $connection, __METHOD__);
try {
$this->executeCommand('QUIT');
} catch (SocketException $e) {
// ignore errors when quitting a closed connection
}
fclose($socket);
}
$this->_pool = [];
}
Defined in:
yii\
Detaches a behavior from the component.
The behavior's yii\
| public detachBehavior( string $name ): yii\ | ||
| $name | string |
The behavior's name. |
| return | yii\ |
The detached behavior. Null if the behavior does not exist. |
|---|---|---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
Defined in:
yii\
Detaches all behaviors from the component.
| public detachBehaviors( ): mixed |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
Defined in:
yii\
Makes sure that the behaviors declared in behaviors() are attached to this component.
| public ensureBehaviors( ): mixed |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
Executes a redis command.
For a list of available commands and their parameters see https://redis.io/commands.
The params array should contain the params separated by white space, e.g. to execute
SET mykey somevalue NX call the following:
$redis->executeCommand('SET', ['mykey', 'somevalue', 'NX']);
| public executeCommand( string $name, array $params = [] ): array|boolean|null|string | ||
| $name | string |
The name of the command |
| $params | array |
List of parameters for the command |
| return | array|boolean|null|string |
Dependent on the executed command this method will return different data types:
See redis protocol description for details on the mentioned reply types. |
|---|---|---|
| throws | yii\ |
for commands that return error reply. |
public function executeCommand(string $name, array $params = [])
{
$this->open();
$params = array_merge(explode(' ', $name), $params);
$command = '*' . count($params) . "\r\n";
foreach ($params as $arg) {
$command .= '$' . mb_strlen($arg ?? '', '8bit') . "\r\n" . $arg . "\r\n";
}
\Yii::debug("Executing Redis Command: {$name}", __METHOD__);
if ($this->retries > 0) {
$tries = $this->retries;
while ($tries-- > 0) {
try {
return $this->sendRawCommand($command, $params);
} catch (SocketException $e) {
\Yii::error($e, __METHOD__);
// backup retries, fail on commands that fail inside here
$retries = $this->retries;
$this->retries = 0;
$this->close();
if ($this->retryInterval > 0) {
usleep($this->retryInterval);
}
try {
$this->open();
} catch (SocketException $exception) {
// Fail to run initial commands, skip current try
\Yii::error($exception, __METHOD__);
$this->close();
} catch (Exception $exception) {
$this->close();
}
$this->retries = $retries;
}
}
}
return $this->sendRawCommand($command, $params);
}
Defined in:
yii\
Returns the named behavior object.
| public getBehavior( string $name ): yii\ | ||
| $name | string |
The behavior name |
| return | yii\ |
The behavior object, or null if the behavior does not exist |
|---|---|---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
Defined in:
yii\
Returns all behaviors attached to this component.
| public getBehaviors( ): array<yii\ | ||
| return | array<yii\ |
List of behaviors attached to this component |
|---|---|---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
Return the connection string used to open a socket connection. During a redirect (cluster mode) this will be the target of the redirect.
| public getConnectionString( ): string | ||
| return | string |
Socket connection string |
|---|---|---|
public function getConnectionString()
{
if ($this->unixSocket) {
return 'unix://' . $this->unixSocket;
}
return $this->scheme . '://' . ($this->redirectConnectionString ?: "$this->hostname:$this->port");
}
Returns the name of the DB driver for the current dsn.
| public getDriverName( ): string | ||
| return | string |
Name of the DB driver |
|---|---|---|
public function getDriverName()
{
return 'redis';
}
Returns a value indicating whether the DB connection is established.
| public getIsActive( ): boolean | ||
| return | boolean |
Whether the DB connection is established |
|---|---|---|
public function getIsActive(): bool
{
return ArrayHelper::getValue($this->_pool, $this->connectionString, false) !== false;
}
| public getLuaScriptBuilder( ): yii\ |
public function getLuaScriptBuilder()
{
return new LuaScriptBuilder();
}
Return the connection resource if a connection to the target has been established before, false otherwise.
| public getSocket( ): resource|false |
public function getSocket()
{
return ArrayHelper::getValue($this->_pool, $this->connectionString, false);
}
Defined in:
yii\
Returns a value indicating whether there is any handler attached to the named event.
| public hasEventHandlers( string $name ): boolean | ||
| $name | string |
The event name |
| return | boolean |
Whether there is any handler attached to the event. |
|---|---|---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
Defined in:
yii\
Returns a value indicating whether a method is defined.
A method is defined if:
- the class has a method with the specified name
- an attached behavior has a method with the given name (when
$checkBehaviorsis true).
| public hasMethod( string $name, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkBehaviors | boolean |
Whether to treat behaviors' methods as methods of this component |
| return | boolean |
Whether the method is defined |
|---|---|---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
Defined in:
yii\
Returns a value indicating whether a property is defined for this component.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true); - an attached behavior has a property of the given name (when
$checkBehaviorsis true).
See also:
| public hasProperty( string $name, boolean $checkVars = true, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| $checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
| return | boolean |
Whether the property is defined |
|---|---|---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Defined in:
yii\
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public init( ): mixed |
public function init()
{
}
Initializes the DB connection.
This method is invoked right after the DB connection is established. The default implementation triggers an EVENT_AFTER_OPEN event.
| protected initConnection( ): mixed |
protected function initConnection()
{
$this->trigger(self::EVENT_AFTER_OPEN);
}
Defined in:
yii\
Detaches an existing event handler from this component.
This method is the opposite of on().
Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.
See also on().
| public off( string $name, callable|null $handler = null ): boolean | ||
| $name | string |
Event name |
| $handler | callable|null |
The event handler to be removed. If it is null, all handlers attached to the named event will be removed. |
| return | boolean |
If a handler is found and detached |
|---|---|---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
Defined in:
yii\
Attaches an event handler to an event.
The event handler must be a valid PHP callback. The following are some examples:
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
The event handler must be defined with the following signature,
function ($event)
where $event is an yii\
Since 2.0.14 you can specify event name as a wildcard pattern:
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
See also off().
| public on( string $name, callable $handler, mixed $data = null, boolean $append = true ): mixed | ||
| $name | string |
The event name |
| $handler | callable |
The event handler |
| $data | mixed |
The data to be passed to the event handler when the event is triggered.
When the event handler is invoked, this data can be accessed via yii\ |
| $append | boolean |
Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list. |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
Establishes a DB connection.
It does nothing if a DB connection has already been established.
| public open( ): void | ||
| throws | yii\ |
if connection fails |
|---|---|---|
public function open(): void
{
if ($this->socket !== false) {
return;
}
$connection = $this->connectionString . ', database=' . $this->database;
\Yii::debug('Opening redis DB connection: ' . $connection, __METHOD__);
$socket = @stream_socket_client(
$this->connectionString,
$errorNumber,
$errorDescription,
$this->connectionTimeout ?: ini_get('default_socket_timeout'),
$this->socketClientFlags,
stream_context_create($this->contextOptions)
);
if ($socket) {
$this->_pool[ $this->connectionString ] = $socket;
if ($this->dataTimeout !== null) {
stream_set_timeout($socket, $timeout = (int) $this->dataTimeout, (int) (($this->dataTimeout - $timeout) * 1000000));
}
if ($this->useSSL) {
stream_socket_enable_crypto($socket, true, STREAM_CRYPTO_METHOD_TLS_CLIENT);
}
if ($this->password !== null) {
$this->executeCommand('AUTH', array_filter([$this->username, $this->password]));
}
if ($this->database !== null) {
$this->executeCommand('SELECT', [$this->database]);
}
$this->initConnection();
} else {
\Yii::error("Failed to open redis DB connection ($connection): $errorNumber - $errorDescription", __CLASS__);
$message = YII_DEBUG ? "Failed to open redis DB connection ($connection): $errorNumber - $errorDescription" : 'Failed to open DB connection.';
throw new Exception($message, $errorDescription, $errorNumber);
}
}
Sends RAW command string to the server.
| protected sendRawCommand( string $command, array $params ): array|boolean|null|string | ||
| $command | string |
Command string |
| $params | array |
List of parameters for the command |
| return | array|boolean|null|string |
Dependent on the executed command this method will return different data types:
See redis protocol description for details on the mentioned reply types. |
|---|---|---|
| throws | yii\ |
for commands that return error reply. |
| throws | yii\ |
on connection error. |
protected function sendRawCommand($command, $params)
{
$written = @fwrite($this->socket, $command);
if ($written === false) {
throw new SocketException("Failed to write to socket.\nRedis command was: " . $command);
}
if ($written !== ($len = mb_strlen($command, '8bit'))) {
throw new SocketException("Failed to write to socket. $written of $len bytes written.\nRedis command was: " . $command);
}
return $this->parseResponse($params, $command);
}
Defined in:
yii\
Triggers an event.
This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.
| public trigger( string $name, yii\ | ||
| $name | string |
The event name |
| $event | yii\ |
The event instance. If not set, a default yii\ |
public function trigger($name, ?Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}