Fix phpdoc QueryBuilder conditions classes. (#583)

terabytesoftw · web-flow · commit 05df642e8c53 · 2023-03-07T18:56:12.000-03:00
diff --git a/src/QueryBuilder/Condition/Builder/BetweenColumnsConditionBuilder.php b/src/QueryBuilder/Condition/Builder/BetweenColumnsConditionBuilder.php
@@ -17,7 +17,7 @@
 use function str_contains;
 
 /**
- * Class BetweenColumnsConditionBuilder builds objects of {@see BetweenColumnsCondition}.
+ * Build an object of {@see BetweenColumnsCondition} into SQL expressions.
  */
 class BetweenColumnsConditionBuilder implements ExpressionBuilderInterface
 {
@@ -43,7 +43,7 @@ public function build(BetweenColumnsConditionInterface $expression, array &$para
     }
 
     /**
-     * Attaches $value to $params array and returns placeholder.
+     * Attaches `$value` to `$params` array and return placeholder.
      *
      * @throws Exception
      * @throws InvalidArgumentException
diff --git a/src/QueryBuilder/Condition/Builder/BetweenConditionBuilder.php b/src/QueryBuilder/Condition/Builder/BetweenConditionBuilder.php
@@ -16,7 +16,7 @@
 use function str_contains;
 
 /**
- * Class BetweenConditionBuilder builds objects of {@see BetweenCondition}.
+ * Build an object of {@see BetweenCondition} into SQL expressions.
  */
 class BetweenConditionBuilder implements ExpressionBuilderInterface
 {
@@ -49,7 +49,7 @@ public function build(BetweenConditionInterface $expression, array &$params = []
     }
 
     /**
-     * Attaches $value to $params array and returns placeholder.
+     * Attaches `$value` to `$params` array and return placeholder.
      *
      * @throws Exception
      * @throws InvalidArgumentException
diff --git a/src/QueryBuilder/Condition/Builder/ConjunctionConditionBuilder.php b/src/QueryBuilder/Condition/Builder/ConjunctionConditionBuilder.php
@@ -21,7 +21,7 @@
 use function reset;
 
 /**
- * Class ConjunctionConditionBuilder builds objects of abstract class {@see AbstractConjunctionCondition}.
+ * Build an object of {@see AbstractConjunctionCondition} into SQL expressions.
  */
 class ConjunctionConditionBuilder implements ExpressionBuilderInterface
 {
diff --git a/src/QueryBuilder/Condition/Builder/ExistsConditionBuilder.php b/src/QueryBuilder/Condition/Builder/ExistsConditionBuilder.php
@@ -13,7 +13,7 @@
 use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
 
 /**
- * Class ExistsConditionBuilder builds objects of {@see ExistsCondition}.
+ * Build an object of {@see ExistsCondition} into SQL expressions.
  */
 class ExistsConditionBuilder implements ExpressionBuilderInterface
 {
diff --git a/src/QueryBuilder/Condition/Builder/HashConditionBuilder.php b/src/QueryBuilder/Condition/Builder/HashConditionBuilder.php
@@ -21,7 +21,7 @@
 use function str_contains;
 
 /**
- * Class HashConditionBuilder builds objects of {@see HashCondition}.
+ * Build an object of {@see HashCondition} into SQL expressions.
  */
 class HashConditionBuilder implements ExpressionBuilderInterface
 {
diff --git a/src/QueryBuilder/Condition/Builder/InConditionBuilder.php b/src/QueryBuilder/Condition/Builder/InConditionBuilder.php
@@ -31,7 +31,7 @@
 use function strtoupper;
 
 /**
- * Class InConditionBuilder builds objects of {@see InCondition}.
+ * Build an object of {@see InCondition} into SQL expressions.
  */
 class InConditionBuilder implements ExpressionBuilderInterface
 {
@@ -127,7 +127,7 @@ public function build(InConditionInterface $expression, array &$params = []): st
     }
 
     /**
-     * Builds $values to be used in {@see InCondition}.
+     * Builds `$values` to be used in {@see InCondition}.
      *
      * @throws Exception|InvalidArgumentException|InvalidConfigException|NotSupportedException
      *
@@ -218,7 +218,7 @@ protected function buildSubqueryInCondition(
     }
 
     /**
-     * Builds a SQL statement for checking the existence of rows with the specified composite column values.
+     * Builds an SQL statement for checking the existence of rows with the specified composite column values.
      *
      * @throws Exception
      * @throws InvalidConfigException
@@ -272,7 +272,7 @@ protected function buildCompositeInCondition(
     }
 
     /**
-     * Builds is null/is not null condition for column based on operator.
+     * The Builds are `null/is` not `null` condition for column based on the operator.
      */
     protected function getNullCondition(string $operator, string $column): string
     {
diff --git a/src/QueryBuilder/Condition/Builder/LikeConditionBuilder.php b/src/QueryBuilder/Condition/Builder/LikeConditionBuilder.php
@@ -21,7 +21,7 @@
 use function strtr;
 
 /**
- * Class LikeConditionBuilder builds objects of {@see LikeCondition}.
+ * Build an object of {@see LikeCondition} into SQL expressions.
  */
 class LikeConditionBuilder implements ExpressionBuilderInterface
 {
diff --git a/src/QueryBuilder/Condition/Builder/NotConditionBuilder.php b/src/QueryBuilder/Condition/Builder/NotConditionBuilder.php
@@ -13,7 +13,7 @@
 use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
 
 /**
- * Class NotConditionBuilder builds objects of {@see NotCondition}.
+ * Build an object of {@see NotCondition} into SQL expressions.
  */
 class NotConditionBuilder implements ExpressionBuilderInterface
 {
diff --git a/src/QueryBuilder/Condition/Builder/SimpleConditionBuilder.php b/src/QueryBuilder/Condition/Builder/SimpleConditionBuilder.php
@@ -16,7 +16,7 @@
 use function str_contains;
 
 /**
- * Class NotConditionBuilder builds objects of {@see SimpleCondition}.
+ * Build an object of {@see SimpleCondition} into SQL expressions.
  */
 class SimpleConditionBuilder implements ExpressionBuilderInterface
 {
diff --git a/src/QueryBuilder/Condition/Interface/BetweenColumnsConditionInterface.php b/src/QueryBuilder/Condition/Interface/BetweenColumnsConditionInterface.php
@@ -8,23 +8,22 @@
 use Yiisoft\Db\Expression\ExpressionInterface;
 
 /**
- * Interface BetweenColumnsConditionInterface represents a condition that is based on the comparison of a column with a
- * value.
+ * Represents a condition which is used to check if a value is between two values.
  */
 interface BetweenColumnsConditionInterface extends ConditionInterface
 {
     /**
-     * @return ExpressionInterface|string The column name or expression that is an end of the interval.
+     * @return ExpressionInterface|string The column name or expression that's an end of the interval.
      */
     public function getIntervalEndColumn(): string|ExpressionInterface;
 
     /**
-     * @return ExpressionInterface|string The column name or expression that is a beginning of the interval.
+     * @return ExpressionInterface|string The column name or expression that's the beginning of the interval.
      */
     public function getIntervalStartColumn(): string|ExpressionInterface;
 
     /**
-     * @return string The operator to use (e.g. `BETWEEN` or `NOT BETWEEN`).
+     * @return string The operator to use (for example `BETWEEN` or `NOT BETWEEN`).
      */
     public function getOperator(): string;
 
diff --git a/src/QueryBuilder/Condition/Interface/BetweenConditionInterface.php b/src/QueryBuilder/Condition/Interface/BetweenConditionInterface.php
@@ -7,7 +7,7 @@
 use Yiisoft\Db\Expression\ExpressionInterface;
 
 /**
- * Interface BetweenConditionInterface represents a condition which is used to check if a value is between two values.
+ * Represents a condition which is used to check if a value is between two values.
  */
 interface BetweenConditionInterface extends ConditionInterface
 {
@@ -27,7 +27,7 @@ public function getIntervalEnd(): mixed;
     public function getIntervalStart(): mixed;
 
     /**
-     * @return string The operator to use (e.g. `BETWEEN` or `NOT BETWEEN`).
+     * @return string The operator to use (for example `BETWEEN` or `NOT BETWEEN`).
      */
     public function getOperator(): string;
 }
diff --git a/src/QueryBuilder/Condition/Interface/ConditionInterface.php b/src/QueryBuilder/Condition/Interface/ConditionInterface.php
@@ -8,7 +8,7 @@
 use Yiisoft\Db\Expression\ExpressionInterface;
 
 /**
- * Interface ConditionInterface should be implemented by classes that represent a condition in DBAL of framework.
+ * Should be implemented by classes that represent a condition in the {@see \Yiisoft\Db\QueryBuilder\QueryBuilder}.
  */
 interface ConditionInterface extends ExpressionInterface
 {
@@ -18,7 +18,7 @@ interface ConditionInterface extends ExpressionInterface
      * @param string $operator Operator in uppercase.
      * @param array  $operands Array of corresponding operands
      *
-     * @throws InvalidArgumentException If input parameters are not suitable for this condition.
+     * @throws InvalidArgumentException If input parameters aren't suitable for this condition.
      */
     public static function fromArrayDefinition(string $operator, array $operands): self;
 }
diff --git a/src/QueryBuilder/Condition/Interface/ConjunctionConditionInterface.php b/src/QueryBuilder/Condition/Interface/ConjunctionConditionInterface.php
@@ -5,13 +5,13 @@
 namespace Yiisoft\Db\QueryBuilder\Condition\Interface;
 
 /**
- * ConjunctionConditionInterface represents a condition that is composed by multiple other conditions connected by a
- * conjunction (e.g. `AND`, `OR`).
+ * Represents a condition that's composed by many other conditions connected by a conjunction
+ * (for example, `AND`, `OR`).
  */
 interface ConjunctionConditionInterface extends ConditionInterface
 {
     /**
-     * @return string The operator that is represented by this condition class, e.g. `AND`, `OR`.
+     * @return string The operator that's represented by this condition class, e.g. `AND`, `OR`.
      */
     public function getOperator(): string;
 
diff --git a/src/QueryBuilder/Condition/Interface/ExistConditionInterface.php b/src/QueryBuilder/Condition/Interface/ExistConditionInterface.php
@@ -7,12 +7,12 @@
 use Yiisoft\Db\Query\QueryInterface;
 
 /**
- * ExistConditionInterface represents a condition that checks whether a sub-query returns any rows.
+ * Represents a condition that checks whether a sub-query returns any rows.
  */
 interface ExistConditionInterface extends ConditionInterface
 {
     /**
-     * @return string The operator to use (e.g. `EXISTS` or `NOT EXISTS`).
+     * @return string The operator to use (for example, `EXISTS` or `NOT EXISTS`).
      */
     public function getOperator(): string;
 
diff --git a/src/QueryBuilder/Condition/Interface/HashConditionInterface.php b/src/QueryBuilder/Condition/Interface/HashConditionInterface.php
@@ -5,7 +5,7 @@
 namespace Yiisoft\Db\QueryBuilder\Condition\Interface;
 
 /**
- * HashConditionInterface is the interface that should be implemented by classes that represent a hash condition.
+ * Should be implemented by classes that represent a hash condition.
  */
 interface HashConditionInterface extends ConditionInterface
 {
diff --git a/src/QueryBuilder/Condition/Interface/InConditionInterface.php b/src/QueryBuilder/Condition/Interface/InConditionInterface.php
@@ -9,7 +9,7 @@
 use Yiisoft\Db\Query\QueryInterface;
 
 /**
- * Interface InConditionInterface represents a condition that is based on `IN` operator.
+ * Represents a condition that's based on `IN` operator.
  */
 interface InConditionInterface extends ConditionInterface
 {
diff --git a/src/QueryBuilder/Condition/Interface/LikeConditionInterface.php b/src/QueryBuilder/Condition/Interface/LikeConditionInterface.php
@@ -8,7 +8,7 @@
 use Yiisoft\Db\Expression\ExpressionInterface;
 
 /**
- * LikeConditionInterface is the interface that must be implemented by classes that represent a LIKE condition.
+ * Represents a condition that's based on `LIKE` operator.
  */
 interface LikeConditionInterface extends ConditionInterface
 {
@@ -29,8 +29,8 @@ public function getEscapingReplacements(): ?array;
      * counterparts.
      *
      * You may use an empty array to indicate the values are already escaped and no escape should be applied.
-     * Note that when using an escape mapping (or the third operand is not provided), the values will be automatically
-     * enclosed within a pair of percentage characters.
+     * Note that when using an escape mapping (or the third operand isn't provided), the values will be automatically
+     * inside within a pair of percentage characters.
      */
     public function setEscapingReplacements(array|null $escapingReplacements): void;
 
diff --git a/src/QueryBuilder/Condition/Interface/NotConditionInterface.php b/src/QueryBuilder/Condition/Interface/NotConditionInterface.php
@@ -7,7 +7,7 @@
 use Yiisoft\Db\Expression\ExpressionInterface;
 
 /**
- * Interface NotConditionInterface represents a condition that can be negated.
+ * Represents a condition that's based on `NOT` operator.
  */
 interface NotConditionInterface extends ConditionInterface
 {
diff --git a/src/QueryBuilder/Condition/Interface/SimpleConditionInterface.php b/src/QueryBuilder/Condition/Interface/SimpleConditionInterface.php
@@ -7,13 +7,13 @@
 use Yiisoft\Db\Expression\ExpressionInterface;
 
 /**
- * Interface SimpleConditionInterface represents a simple condition, such as `column = value`.
+ * Represents a simple condition, such as `column = value`.
  */
 interface SimpleConditionInterface extends ConditionInterface
 {
     /**
-     * @return ExpressionInterface|string The column name. If it is an array, a composite `IN` condition
-     * will be generated.
+     * @return ExpressionInterface|string The column name. If it's an array, a composite `IN` condition will be
+     * generated.
      */
     public function getColumn(): string|ExpressionInterface;
 

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`use function str_contains;`
`18`	`18`
`19`	`19`	`/**`
`20`		`- * Class BetweenColumnsConditionBuilder builds objects of {@see BetweenColumnsCondition}.`
	`20`	`+ * Build an object of {@see BetweenColumnsCondition} into SQL expressions.`
`21`	`21`	`*/`
`22`	`22`	`class BetweenColumnsConditionBuilder implements ExpressionBuilderInterface`
`23`	`23`	`{`
`@@ -43,7 +43,7 @@ public function build(BetweenColumnsConditionInterface $expression, array &$para`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`/**`
`46`		`- * Attaches $value to $params array and returns placeholder.`
	`46`	+ * Attaches `$value` to `$params` array and return placeholder.
`47`	`47`	`*`
`48`	`48`	`* @throws Exception`
`49`	`49`	`* @throws InvalidArgumentException`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`use function str_contains;`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Class BetweenConditionBuilder builds objects of {@see BetweenCondition}.`
	`19`	`+ * Build an object of {@see BetweenCondition} into SQL expressions.`
`20`	`20`	`*/`
`21`	`21`	`class BetweenConditionBuilder implements ExpressionBuilderInterface`
`22`	`22`	`{`
`@@ -49,7 +49,7 @@ public function build(BetweenConditionInterface $expression, array &$params = []`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * Attaches $value to $params array and returns placeholder.`
	`52`	+ * Attaches `$value` to `$params` array and return placeholder.
`53`	`53`	`*`
`54`	`54`	`* @throws Exception`
`55`	`55`	`* @throws InvalidArgumentException`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`use function reset;`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * Class ConjunctionConditionBuilder builds objects of abstract class {@see AbstractConjunctionCondition}.`
	`24`	`+ * Build an object of {@see AbstractConjunctionCondition} into SQL expressions.`
`25`	`25`	`*/`
`26`	`26`	`class ConjunctionConditionBuilder implements ExpressionBuilderInterface`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * Class ExistsConditionBuilder builds objects of {@see ExistsCondition}.`
	`16`	`+ * Build an object of {@see ExistsCondition} into SQL expressions.`
`17`	`17`	`*/`
`18`	`18`	`class ExistsConditionBuilder implements ExpressionBuilderInterface`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`use function strtoupper;`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * Class InConditionBuilder builds objects of {@see InCondition}.`
	`34`	`+ * Build an object of {@see InCondition} into SQL expressions.`
`35`	`35`	`*/`
`36`	`36`	`class InConditionBuilder implements ExpressionBuilderInterface`
`37`	`37`	`{`
`@@ -127,7 +127,7 @@ public function build(InConditionInterface $expression, array &$params = []): st`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`/**`
`130`		`- * Builds $values to be used in {@see InCondition}.`
	`130`	+ * Builds `$values` to be used in {@see InCondition}.
`131`	`131`	`*`
`132`	`132`	`* @throws Exception\|InvalidArgumentException\|InvalidConfigException\|NotSupportedException`
`133`	`133`	`*`
`@@ -218,7 +218,7 @@ protected function buildSubqueryInCondition(`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`/**`
`221`		`- * Builds a SQL statement for checking the existence of rows with the specified composite column values.`
	`221`	`+ * Builds an SQL statement for checking the existence of rows with the specified composite column values.`
`222`	`222`	`*`
`223`	`223`	`* @throws Exception`
`224`	`224`	`* @throws InvalidConfigException`
`@@ -272,7 +272,7 @@ protected function buildCompositeInCondition(`
`272`	`272`	`}`
`273`	`273`
`274`	`274`	`/**`
`275`		`- * Builds is null/is not null condition for column based on operator.`
	`275`	+ * The Builds are `null/is` not `null` condition for column based on the operator.
`276`	`276`	`*/`
`277`	`277`	`protected function getNullCondition(string $operator, string $column): string`
`278`	`278`	`{`