Class yii\elasticsearch\Connection
| Inheritance | yii\ |
|---|---|
| Implements | yii\ |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/Connection.php |
Elasticsearch Connection is used to connect to an Elasticsearch cluster version 0.20 or higher
Public Properties
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | 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\ |
| createBulkCommand() | Creates a bulk command for execution. | yii\ |
| createCommand() | Creates a command for execution. | yii\ |
| delete() | Performs DELETE HTTP request | 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\ |
| get() | Performs GET HTTP request | yii\ |
| getBehavior() | Returns the named behavior object. | yii\ |
| getBehaviors() | Returns all behaviors attached to this component. | yii\ |
| getClusterState() | 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\ |
| getNodeInfo() | yii\ |
|
| getQueryBuilder() | Creates new query builder instance | 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\ |
| head() | Performs HEAD HTTP request | yii\ |
| init() | 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\ |
| post() | Performs POST HTTP request | yii\ |
| put() | Performs PUT HTTP request | yii\ |
| trigger() | Triggers an event. | yii\ |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| decodeErrorBody() | Try to decode error information if it is valid json, return it if not. | yii\ |
| httpRequest() | Performs HTTP request | yii\ |
| initConnection() | Initializes the DB connection. | yii\ |
| populateNodes() | Populates $nodes with the result of a cluster nodes request. | yii\ |
| selectActiveNode() | Select active node randomly | yii\ |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_OPEN | yii\elasticsearch\Event | An event that is triggered after a DB connection is established | yii\ |
Property Details
Authentication data used to connect to the Elasticsearch node.
Array elements:
username: the username for authentication.password: the password for authentication.
Array either MUST contain both username and password on not contain any authentication credentials.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html.
Whether to autodetect available cluster nodes on open()
Timeout to use for connecting to an Elasticsearch node.
This value will be used to configure the curl CURLOPT_CONNECTTIMEOUT option.
If not set, no explicit timeout will be set for curl.
Additional options used to configure curl session
Timeout to use when reading the response from an Elasticsearch node.
This value will be used to configure the curl CURLOPT_TIMEOUT option.
If not set, no explicit timeout will be set for curl.
Default protocol to connect to nodes
Version of the domain-specific language to use with the server.
This must be set to the major version of the Elasticsearch server in use, e.g. 5 for Elasticsearch 5.x.x,
6 for Elasticsearch 6.x.x, and 7 for Elasticsearch 7.x.x.
The Elasticsearch cluster nodes to connect to.
This is populated with the result of a cluster nodes request when $autodetectCluster is true.
Additional special options:
auth: overrides $auth property. For example:
[
'http_address' => 'inet[/127.0.0.1:9200]',
'auth' => ['username' => 'yiiuser', 'password' => 'yiipw'], // Overrides the `auth` property of the class with specific login and password
//'auth' => ['username' => 'yiiuser', 'password' => 'yiipw'], // Disabled auth regardless of `auth` property of the class
]
protocol: explicitly sets the protocol for the current node (useful when manually defining a HTTPS cluster)
Method Details
Defined in:
yii\
Calls the named method which is not a class method.
This method will check if any attached behavior has the named method and will execute it if available.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
| public __call( string $name, array $params ): mixed | ||
| $name | string |
The method name |
| $params | array |
Method parameters |
| return | mixed |
The method return value |
|---|---|---|
| throws | yii\ |
when calling unknown method |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
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( ): mixed |
public function close()
{
if ($this->activeNode === null) {
return;
}
Yii::debug('Closing connection to Elasticsearch. Active node was: '
. $this->nodes[$this->activeNode]['http']['publish_address'], __CLASS__);
$this->activeNode = null;
if ($this->_curl) {
curl_close($this->_curl);
$this->_curl = null;
}
}
Creates a bulk command for execution.
| public createBulkCommand( array $config = [] ): yii\ | ||
| $config | array |
The configuration for the yii\ |
| return | yii\ |
The DB command |
|---|---|---|
public function createBulkCommand($config = [])
{
$this->open();
$config['db'] = $this;
$command = new BulkCommand($config);
return $command;
}
Creates a command for execution.
| public createCommand( array $config = [] ): yii\ | ||
| $config | array |
The configuration for the Command class |
| return | yii\ |
The DB command |
|---|---|---|
public function createCommand($config = [])
{
$this->open();
$config['db'] = $this;
$command = new Command($config);
return $command;
}
Try to decode error information if it is valid json, return it if not.
| protected decodeErrorBody( mixed $body ): mixed | ||
| $body | mixed | |
protected function decodeErrorBody($body)
{
try {
$decoded = Json::decode($body);
if (isset($decoded['error']) && !is_array($decoded['error'])) {
$decoded['error'] = preg_replace('/\b\w+?Exception\[/', "<span style=\"color: red;\">\\0</span>\n ", $decoded['error']);
}
return $decoded;
} catch (InvalidArgumentException $e) {
return $body;
}
}
Performs DELETE HTTP request
| public delete( string|array $url, array $options = [], string $body = null, boolean $raw = false ): mixed | ||
| $url | string|array |
URL |
| $options | array |
URL options |
| $body | string |
Request body |
| $raw | boolean |
If response body contains JSON and should be decoded |
| return | mixed |
Response |
|---|---|---|
| throws | yii\ |
|
| throws | yii\ |
|
public function delete($url, $options = [], $body = null, $raw = false)
{
$this->open();
return $this->httpRequest('DELETE', $this->createUrl($url, $options), $body, $raw);
}
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);
}
}
}
Performs GET HTTP request
| public get( string|array $url, array $options = [], string $body = null, boolean $raw = false ): mixed | ||
| $url | string|array |
URL |
| $options | array |
URL options |
| $body | string |
Request body |
| $raw | boolean |
If response body contains JSON and should be decoded |
| return | mixed |
Response |
|---|---|---|
| throws | yii\ |
|
| throws | yii\ |
|
public function get($url, $options = [], $body = null, $raw = false)
{
$this->open();
return $this->httpRequest('GET', $this->createUrl($url, $options), $body, $raw);
}
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;
}
| public getClusterState( ): mixed |
public function getClusterState()
{
return $this->get(['_cluster', 'state']);
}
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 'elasticsearch';
}
Returns a value indicating whether the DB connection is established.
| public getIsActive( ): boolean | ||
| return | boolean |
Whether the DB connection is established |
|---|---|---|
public function getIsActive()
{
return $this->activeNode !== null;
}
Creates new query builder instance
| public getQueryBuilder( ): yii\ |
public function getQueryBuilder()
{
return new QueryBuilder($this);
}
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);
}
Performs HEAD HTTP request
| public head( string|array $url, array $options = [], string $body = null ): mixed | ||
| $url | string|array |
URL |
| $options | array |
URL options |
| $body | string |
Request body |
| return | mixed |
Response |
|---|---|---|
| throws | yii\ |
|
| throws | yii\ |
|
public function head($url, $options = [], $body = null)
{
$this->open();
return $this->httpRequest('HEAD', $this->createUrl($url, $options), $body);
}
Performs HTTP request
| protected httpRequest( string $method, string $url, string $requestBody = null, boolean $raw = false ): mixed | ||
| $method | string |
Method name |
| $url | string |
URL |
| $requestBody | string |
Request body |
| $raw | boolean |
If response body contains JSON and should be decoded |
| return | mixed |
If request failed |
|---|---|---|
| throws | yii\ |
if request failed |
| throws | yii\ |
|
protected function httpRequest($method, $url, $requestBody = null, $raw = false)
{
$method = strtoupper($method);
// response body and headers
$headers = [];
$headersFinished = false;
$body = '';
$options = [
CURLOPT_USERAGENT => 'Yii Framework ' . Yii::getVersion() . ' ' . __CLASS__,
CURLOPT_RETURNTRANSFER => false,
CURLOPT_HEADER => false,
// https://www.php.net/manual/en/function.curl-setopt.php#82418
CURLOPT_HTTPHEADER => [
'Expect:',
'Content-Type: application/json',
],
CURLOPT_WRITEFUNCTION => function ($curl, $data) use (&$body) {
$body .= $data;
return mb_strlen($data, '8bit');
},
CURLOPT_HEADERFUNCTION => function ($curl, $data) use (&$headers, &$headersFinished) {
if ($data === '') {
$headersFinished = true;
} elseif ($headersFinished) {
$headersFinished = false;
}
if (!$headersFinished && ($pos = strpos($data, ':')) !== false) {
$headers[strtolower(substr($data, 0, $pos))] = trim(substr($data, $pos + 1));
}
return mb_strlen($data, '8bit');
},
CURLOPT_CUSTOMREQUEST => $method,
CURLOPT_FORBID_REUSE => false,
];
foreach ($this->curlOptions as $key => $value) {
$options[$key] = $value;
}
if (!empty($this->auth) || isset($this->nodes[$this->activeNode]['auth']) && $this->nodes[$this->activeNode]['auth'] !== false) {
$auth = isset($this->nodes[$this->activeNode]['auth']) ? $this->nodes[$this->activeNode]['auth'] : $this->auth;
if (empty($auth['username'])) {
throw new InvalidConfigException('Username is required to use authentication');
}
if (empty($auth['password'])) {
throw new InvalidConfigException('Password is required to use authentication');
}
$options[CURLOPT_HTTPAUTH] = CURLAUTH_BASIC;
$options[CURLOPT_USERPWD] = $auth['username'] . ':' . $auth['password'];
}
if ($this->connectionTimeout !== null) {
$options[CURLOPT_CONNECTTIMEOUT] = $this->connectionTimeout;
}
if ($this->dataTimeout !== null) {
$options[CURLOPT_TIMEOUT] = $this->dataTimeout;
}
if ($requestBody !== null) {
$options[CURLOPT_POSTFIELDS] = $requestBody;
}
if ($method == 'HEAD') {
$options[CURLOPT_NOBODY] = true;
unset($options[CURLOPT_WRITEFUNCTION]);
} else {
$options[CURLOPT_NOBODY] = false;
}
if (is_array($url)) {
list($protocol, $host, $q) = $url;
if (strncmp($host, 'inet[', 5) == 0) {
$host = substr($host, 5, -1);
if (($pos = strpos($host, '/')) !== false) {
$host = substr($host, $pos + 1);
}
}
$profile = "$method $q#$requestBody";
$url = "$protocol://$host/$q";
} else {
$profile = false;
}
Yii::debug("Sending request to Elasticsearch node: $method $url\n$requestBody", __METHOD__);
if ($profile !== false) {
Yii::beginProfile($profile, __METHOD__);
}
$this->resetCurlHandle();
curl_setopt($this->_curl, CURLOPT_URL, $url);
curl_setopt_array($this->_curl, $options);
if (curl_exec($this->_curl) === false) {
throw new Exception('Elasticsearch request failed: ' . curl_errno($this->_curl) . ' - ' . curl_error($this->_curl), [
'requestMethod' => $method,
'requestUrl' => $url,
'requestBody' => $requestBody,
'responseHeaders' => $headers,
'responseBody' => $this->decodeErrorBody($body),
]);
}
$responseCode = curl_getinfo($this->_curl, CURLINFO_HTTP_CODE);
if ($profile !== false) {
Yii::endProfile($profile, __METHOD__);
}
if ($responseCode >= 200 && $responseCode < 300) {
if ($method === 'HEAD') {
return true;
} else {
if (isset($headers['content-length']) && ($len = mb_strlen($body, '8bit')) < $headers['content-length']) {
throw new Exception("Incomplete data received from Elasticsearch: $len < {$headers['content-length']}", [
'requestMethod' => $method,
'requestUrl' => $url,
'requestBody' => $requestBody,
'responseCode' => $responseCode,
'responseHeaders' => $headers,
'responseBody' => $body,
]);
}
if (isset($headers['content-type'])) {
if (!strncmp($headers['content-type'], 'application/json', 16)) {
return $raw ? $body : Json::decode($body);
}
if (!strncmp($headers['content-type'], 'text/plain', 10)) {
return $raw ? $body : array_filter(explode("\n", $body));
}
}
throw new Exception('Unsupported data received from Elasticsearch: ' . $headers['content-type'], [
'requestMethod' => $method,
'requestUrl' => $url,
'requestBody' => $requestBody,
'responseCode' => $responseCode,
'responseHeaders' => $headers,
'responseBody' => $this->decodeErrorBody($body),
]);
}
} elseif ($responseCode == 404) {
return false;
} else {
throw new Exception("Elasticsearch request failed with code $responseCode. Response body:\n{$body}", [
'requestMethod' => $method,
'requestUrl' => $url,
'requestBody' => $requestBody,
'responseCode' => $responseCode,
'responseHeaders' => $headers,
'responseBody' => $this->decodeErrorBody($body),
]);
}
}
| public init( ): mixed |
public function init()
{
foreach ($this->nodes as &$node) {
if (!isset($node['http_address'])) {
throw new InvalidConfigException('Elasticsearch node needs at least a http_address configured.');
}
if (!isset($node['protocol'])) {
$node['protocol'] = $this->defaultProtocol;
}
if (!in_array($node['protocol'], ['http', 'https'])) {
throw new InvalidConfigException('Valid node protocol settings are "http" and "https".');
}
}
}
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( ): mixed | ||
| throws | yii\ |
if connection fails |
|---|---|---|
public function open()
{
if ($this->activeNode !== null) {
return;
}
if (empty($this->nodes)) {
throw new InvalidConfigException('Elasticsearch needs at least one node to operate.');
}
$this->_curl = curl_init();
if ($this->autodetectCluster) {
$this->populateNodes();
}
$this->selectActiveNode();
Yii::debug('Opening connection to Elasticsearch. Nodes in cluster: ' . count($this->nodes)
. ', active node: ' . $this->nodes[$this->activeNode]['http_address'], __CLASS__);
$this->initConnection();
}
Populates $nodes with the result of a cluster nodes request.
| protected populateNodes( ): mixed | ||
| throws | yii\ |
if no active node(s) found |
|---|---|---|
protected function populateNodes()
{
$node = reset($this->nodes);
$host = $node['http_address'];
$protocol = isset($node['protocol']) ? $node['protocol'] : $this->defaultProtocol;
if (strncmp($host, 'inet[/', 6) === 0) {
$host = substr($host, 6, -1);
}
$response = $this->httpRequest('GET', "$protocol://$host/_nodes/_all/http");
if (!empty($response['nodes'])) {
$nodes = $response['nodes'];
} else {
$nodes = [];
}
foreach ($nodes as $key => &$node) {
// Make sure that nodes have an 'http_address' property, which is not the case if you're using AWS
// Elasticsearch service (at least as of Oct., 2015). - TO BE VERIFIED
// Temporary workaround - simply ignore all invalid nodes
if (!isset($node['http']['publish_address'])) {
unset($nodes[$key]);
}
$node['http_address'] = $node['http']['publish_address'];
// Protocol is not a standard ES node property, so we add it manually
$node['protocol'] = $this->defaultProtocol;
}
if (!empty($nodes)) {
$this->nodes = array_values($nodes);
} else {
curl_close($this->_curl);
throw new Exception('Cluster autodetection did not find any active node. Make sure a GET /_nodes reguest on the hosts defined in the config returns the "http_address" field for each node.');
}
}
Performs POST HTTP request
| public post( string|array $url, array $options = [], string $body = null, boolean $raw = false ): mixed | ||
| $url | string|array |
URL |
| $options | array |
URL options |
| $body | string |
Request body |
| $raw | boolean |
If response body contains JSON and should be decoded |
| return | mixed |
Response |
|---|---|---|
| throws | yii\ |
|
| throws | yii\ |
|
public function post($url, $options = [], $body = null, $raw = false)
{
$this->open();
return $this->httpRequest('POST', $this->createUrl($url, $options), $body, $raw);
}
Performs PUT HTTP request
| public put( string|array $url, array $options = [], string $body = null, boolean $raw = false ): mixed | ||
| $url | string|array |
URL |
| $options | array |
URL options |
| $body | string |
Request body |
| $raw | boolean |
If response body contains JSON and should be decoded |
| return | mixed |
Response |
|---|---|---|
| throws | yii\ |
|
| throws | yii\ |
|
public function put($url, $options = [], $body = null, $raw = false)
{
$this->open();
return $this->httpRequest('PUT', $this->createUrl($url, $options), $body, $raw);
}
Select active node randomly
| protected selectActiveNode( ): mixed |
protected function selectActiveNode()
{
$keys = array_keys($this->nodes);
$this->activeNode = $keys[random_int(0, count($keys) - 1)];
}
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);
}