Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix AbstractCriterionQuery phpdoc #9

Merged
merged 4 commits into from
Jan 16, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions src/contracts/Values/Query/AbstractCriterionQuery.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,25 @@ abstract class AbstractCriterionQuery
{
public const DEFAULT_LIMIT = 25;

/** @var TCriterion|null */
/** @phpstan-var TCriterion|null */
private ?CriterionInterface $query;

/** @var TSortClause[] */
/**
* @var array<int, AbstractSortClause>
*
* @phpstan-var TSortClause[]
*/
private array $sortClauses;

private ?int $limit;

private int $offset;

/**
* @param TSortClause[]|null $sortClauses
* @param TCriterion|null $query
* @param array<int, AbstractSortClause>|null $sortClauses
*
* @phpstan-param TSortClause[]|null $sortClauses
* @phpstan-param TCriterion|null $query
*/
public function __construct(
?CriterionInterface $query = null,
Expand All @@ -45,15 +51,15 @@ public function __construct(
}

/**
* @param TCriterion|null $criterion
* @phpstan-param TCriterion|null $criterion
*/
final public function setQuery(?CriterionInterface $criterion): void
{
$this->query = $criterion;
}

/**
* @return TCriterion|null
* @phpstan-return TCriterion|null
*/
final public function getQuery(): ?CriterionInterface
{
Expand Down Expand Up @@ -86,7 +92,9 @@ final public function setLimit(?int $limit): void
}

/**
* @return TSortClause[]
* @return array<int, AbstractSortClause>
*
* @phpstan-return TSortClause[]
*/
final public function getSortClauses(): array
{
Expand All @@ -102,6 +110,8 @@ final public function addSortClause(AbstractSortClause $sortClause): void
}

/**
* @param array<int, AbstractSortClause> $sortClauses
*
* @phpstan-param TSortClause[] $sortClauses
*/
final public function setSortClauses(array $sortClauses): void
Expand Down
Loading