PHPDoc updates for better static analysis

[samuelrajan747]

Hi all,

Thanks a lot for developing this package. Can you please update the phpdocs for ActiveQuery and ActiveRecord, especially methods like one, all, hasOne and hasMany? I know it'll be really tricky for a lot of edge cases but if you can at least provide for the default cases and have some example stub files for the edge cases It'd be great.

Thanks in advance.

[samuelrajan747]

Something like this is needed, but I'm afraid it might not cover all edge cases. The best thing to do would be to write an extension service class for phpstan to handle cases like asArray(), indexBy(), column(), etc.

yiisoft/yii2@2b6f0be

[samuelrajan747]

I had to do some hackish doc overrides to get stuff done.
I'm pasting below the snippets of what I'm using for reference.
Thanks in advance.

MyActiveQuery.php

<?php

namespace app\models;

use yii\mongodb\ActiveQuery;

/**
 * @template T of \yii\mongodb\ActiveRecord
 * @method ?T one(?\yii\mongodb\Connection $db = null)
 * @method list<T> all(?\yii\mongodb\Connection $db = null)
 */
class MyActiveQuery extends ActiveQuery

BaseActiveRecord.stub

<?php

namespace yii\db;

use app\models\MyActiveRecord;
use app\models\MyActiveQuery;

abstract class BaseActiveRecord extends Model implements ActiveRecordInterface
{
    /**
     * @template-covariant TRelation of self
     * @param class-string<TRelation> $class
     * @param array $link
     * @return (TRelation is MyActiveRecord ? MyActiveQuery<TRelation> : ActiveQuery)
     */
    public function hasMany($class, $link);

    /**
     * @template-covariant TRelation of self
     * @param class-string<TRelation> $class
     * @param array $link
     * @return (TRelation is MyActiveRecord ? MyActiveQuery<TRelation> : ActiveQuery)
     */
    public function hasOne($class, $link);
}

MyActiveRecord.php

<?php

namespace app\models;

class MyActiveRecord extends \yii\mongodb\ActiveRecord
{
    /**
     * @inheritdoc
     * @return MyActiveQuery<static>
     */
    public static function find(): Scope
    {
        $find = new MyActiveQuery(get_called_class());
        return $find->orderBy('_id desc');
    }
}

[samdark]

Feel free to submit a pull request.