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

docblock query class fixes #1913

Merged
merged 1 commit into from
Nov 15, 2022

Conversation

mringler
Copy link
Contributor

Dang it, I missed a few places when moving the query class docblock into the template. Here is the fix. Sorry.

@dereuromark
Copy link
Contributor

Happens
It is super hard to read this template code

@dereuromark dereuromark merged commit fa19b97 into propelorm:master Nov 15, 2022
@mringler
Copy link
Contributor Author

Totally, the template file is better than the inline version from before, but it is really not great either.

But I think we got it now, here is a diff old vs new:

 /**
- * Base class that represents a query for the 'referrer' table.
- *
- *
+ * Base class that represents a query for the `referrer` table.
  *
  * @method     ChildReferrerQuery orderById($order = Criteria::ASC) Order by the id column
  * @method     ChildReferrerQuery orderByReferrer($order = Criteria::ASC) Order by the referrer column
@@ -65,8 +63,8 @@ use Propel\Runtime\Exception\PropelException;
  *
  * @method     ChildReferrer|null findOneById(int $id) Return the first ChildReferrer filtered by the id column
  * @method     ChildReferrer|null findOneByReferrer(string $referrer) Return the first ChildReferrer filtered by the referrer column
- * @method     ChildReferrer|null findOneByComment(string $comment) Return the first ChildReferrer filtered by the comment column *
-
+ * @method     ChildReferrer|null findOneByComment(string $comment) Return the first ChildReferrer filtered by the comment column
+ *
  * @method     ChildReferrer requirePk($key, ?ConnectionInterface $con = null) Return the ChildReferrer by primary key and throws \Propel\Runtime\Exception\EntityNotFoundException when not found
  * @method     ChildReferrer requireOne(?ConnectionInterface $con = null) Return the first ChildReferrer matching the query and throws \Propel\Runtime\Exception\EntityNotFoundException when not found
  *
@@ -76,15 +74,16 @@ use Propel\Runtime\Exception\PropelException;
  *
  * @method     ChildReferrer[]|Collection find(?ConnectionInterface $con = null) Return ChildReferrer objects based on current ModelCriteria
  * @psalm-method Collection&\Traversable<ChildReferrer> find(?ConnectionInterface $con = null) Return ChildReferrer objects based on current ModelCriteria
- * @method     ChildReferrer[]|Collection findById(int $id) Return ChildReferrer objects filtered by the id column
- * @psalm-method Collection&\Traversable<ChildReferrer> findById(int $id) Return ChildReferrer objects filtered by the id column
- * @method     ChildReferrer[]|Collection findByReferrer(string $referrer) Return ChildReferrer objects filtered by the referrer column
- * @psalm-method Collection&\Traversable<ChildReferrer> findByReferrer(string $referrer) Return ChildReferrer objects filtered by the referrer column
- * @method     ChildReferrer[]|Collection findByComment(string $comment) Return ChildReferrer objects filtered by the comment column
- * @psalm-method Collection&\Traversable<ChildReferrer> findByComment(string $comment) Return ChildReferrer objects filtered by the comment column
+ *
+ * @method     ChildReferrer[]|Collection findById(int|array<int> $id) Return ChildReferrer objects filtered by the id column
+ * @psalm-method Collection&\Traversable<ChildReferrer> findById(int|array<int> $id) Return ChildReferrer objects filtered by the id column
+ * @method     ChildReferrer[]|Collection findByReferrer(string|array<string> $referrer) Return ChildReferrer objects filtered by the referrer column
+ * @psalm-method Collection&\Traversable<ChildReferrer> findByReferrer(string|array<string> $referrer) Return ChildReferrer objects filtered by the referrer column
+ * @method     ChildReferrer[]|Collection findByComment(string|array<string> $comment) Return ChildReferrer objects filtered by the comment column
+ * @psalm-method Collection&\Traversable<ChildReferrer> findByComment(string|array<string> $comment) Return ChildReferrer objects filtered by the comment column
+ *
  * @method     ChildReferrer[]|\Propel\Runtime\Util\PropelModelPager paginate($page = 1, $maxPerPage = 10, ?ConnectionInterface $con = null) Issue a SELECT query based on the current ModelCriteria and uses a page and a maximum number of results per page to compute an offset and a limit
  * @psalm-method \Propel\Runtime\Util\PropelModelPager&\Traversable<ChildReferrer> paginate($page = 1, $maxPerPage = 10, ?ConnectionInterface $con = null) Issue a SELECT query based on the current ModelCriteria and uses a page and a maximum number of results per page to compute an offset and a limit
- *
  */
 abstract class ReferrerQuery extends ModelCriteria
 {

@mringler mringler deleted the bugfix/fix_query_docblock branch September 29, 2023 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants