Skip to content

Commit 27bc8d5

Browse files
Add documentation for the factory methods to Condition and Facet classes (#602)
If people don't read the documentation they are may not aware of the `Condition::` or `Facet::` methods. So it should be documented also in the code via PHPDocs.
1 parent c9c0b19 commit 27bc8d5

16 files changed

+48
-0
lines changed

packages/seal/src/Search/Condition/AndCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::and} factory method.
18+
*/
1619
class AndCondition extends AbstractGroupCondition
1720
{
1821
}

packages/seal/src/Search/Condition/EqualCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::equal} factory method.
18+
*/
1619
class EqualCondition
1720
{
1821
public function __construct(

packages/seal/src/Search/Condition/GeoBoundingBoxCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::geoBoundingBox} factory method.
18+
*/
1619
class GeoBoundingBoxCondition
1720
{
1821
/**

packages/seal/src/Search/Condition/GeoDistanceCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::geoDistance} factory method.
18+
*/
1619
class GeoDistanceCondition
1720
{
1821
/**

packages/seal/src/Search/Condition/GreaterThanCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::greaterThan} factory method.
18+
*/
1619
class GreaterThanCondition
1720
{
1821
public function __construct(

packages/seal/src/Search/Condition/GreaterThanEqualCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::greaterThanEqual} factory method.
18+
*/
1619
class GreaterThanEqualCondition
1720
{
1821
public function __construct(

packages/seal/src/Search/Condition/IdentifierCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::identifier} factory method.
18+
*/
1619
class IdentifierCondition
1720
{
1821
public function __construct(

packages/seal/src/Search/Condition/InCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::in} factory method.
18+
*/
1619
class InCondition
1720
{
1821
/**

packages/seal/src/Search/Condition/LessThanCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::lessThan} factory method.
18+
*/
1619
class LessThanCondition
1720
{
1821
public function __construct(

packages/seal/src/Search/Condition/LessThanEqualCondition.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace CmsIg\Seal\Search\Condition;
1515

16+
/**
17+
* Recommended way to create a new instance is use the {@see Condition::lessThanEqual} factory method.
18+
*/
1619
class LessThanEqualCondition
1720
{
1821
public function __construct(

0 commit comments

Comments
 (0)
SYSTEM_READY >> ...MS