HashCondition

API reference › yii › db › conditions › HashCondition

class	yii\db\conditions\HashCondition
Implements	ConditionInterface
Since	2.0.14
Source	framework/db/conditions/HashCondition.php

Condition based on column-value pairs.

Methods

Method	Description	Defined by
__construct()	HashCondition constructor.	HashCondition
fromArrayDefinition() static	Creates object by array-definition as described in Query Builder – Operator format guide article.	HashCondition
getHash()		HashCondition

Method details

__construct()

public function __construct(array|null $hash)

HashCondition constructor.

Parameters

Parameter	Type	Description
$hash	array|null

fromArrayDefinition()

public static function fromArrayDefinition(mixed $operator, mixed $operands): static

Creates object by array-definition as described in Query Builder – Operator format guide article.

Parameters

Parameter	Type	Description
$operator	mixed	Operator in uppercase.
$operands	mixed	Array of corresponding operands

Returns

static

Throws

• InvalidArgumentException: if input parameters are not suitable for this condition

getHash()

public function getHash(): array|null

Returns

array|null