PhpStorm无法自动完成模型属性

时间:2012-05-26 17:15:46

标签: phpstorm yii

当我使用find(),findAll(),findByAttributes()等时,我希望PhpStorm自动完成模型的属性...

我有一个类似的模型:

/**
 * member model parameters:
 * @property integer $id
 * @property integer $city_id
 * @property string $e_mail
 */

    class Member extends CActiveRecord
    {
        /**
         * @static
         * @param string $className
         * @return Member
         */
        public static function model($className = __CLASS__)
        {
            return parent::model($className);
        }
...

当我使用活动记录方法时:

$member = Member::model()->findByAttributes(array('e_mail'=>'Foo Bar'));

并在我写这篇文章时尝试自动填充:

$member->

它只在列表中提供了CActiveRecord的参数和方法。

我试图改变

    /**
     * Finds a single active record that has the specified attribute values.
     * See {@link find()} for detailed explanation about $condition and $params.
     * @param array $attributes list of attribute values (indexed by attribute names) that the active records should match.
     * An attribute value can be an array which will be used to generate an IN condition.
     * @param mixed $condition query condition or criteria.
     * @param array $params parameters to be bound to an SQL statement.
     * @return CActiveRecord the record found. Null if none is found.
     */
    public function findByAttributes($attributes,$condition='',$params=array())
    {...

此方法从CActiveRecord返回给成员,自己,父,$ this,孩子等的参数... 自动填充仅在“会员”时有效。但是这种方法不仅适用于所有模型而且只适用于成员模型,因此这不是解决方案。

如果有人知道解决方案(最好不要改变框架核心方法),我会很高兴。

2 个答案:

答案 0 :(得分:3)

注意:我的所有令人敬畏的Yii代码都可以在存储库bitbucketherehere上免费获取。如果您讨厌Yii的详细程度,请查看我的 Pii 课程。我想你会完全挖掘它。

我遇到过这个问题,我所做的是为static model()方法增加phpdoc。这可以解决问题,自动完成工作正常。

例如:

class MyModel extends CActiveRecord {

         /**
         * @static
         * @param string $className
         * @return MyModel|CActiveRecord
         */    
         public static function model($className=__CLASS__) {
             .... yada yada yada ...
         }

}

请注意管道和附加类添加到“@return”。这告诉PhpStorm还要在自动完成查找中包含该类。

另外一个注意事项,如果您使用名称空间,则可能需要在某些类名前面加斜杠。只取决于你的项目和包括。

===============更新时间:2013-08-05 ===============

使用PhpStorm v6及更高版本,您可以使用:

   *
   * @return $this
   *

并获得适当的自动完成功能。

另一方面,整个静态“model()”方法是过时的(如Yii),我有一个基础模型类,我现在用于所有项目。它包含静态模型方法;然后在我的每个子类中不再需要它。这是一个例子......

<?php
namespace My\Awesome\Name\Space;

/**
 * MyBaseModel
 * etc.etc.
 */
class MyBaseModel extends \CActiveRecord
{
    /**
     * Returns the static model of the specified AR class.
     *
     * @param string $className
     *
     * @return $this
     */
    public static function model( $className = null )
    {
        return parent::model( $className ? : \get_called_class() );
    }

    //code code code code
}

/**
 * MySubModel
 */
class MySubModel extends MyBaseModel
{
    /**
     * {@InheritDoc}
     */
    public function tableName()
    {
        return 'my_sub_table';
    }
}

$_models = MySubModel::model()->findAll( 'xyz = :xyz', array( ':xyz' => 'abc' ) );

if ( !empty( $_models ) )
{
    foreach ( $_models as $_model )
    {
        //  Do awesome stuff...
    }
}

自动填充功能适用于所有子类......

以为我会更新这个,让你们都知道。

答案 1 :(得分:0)

您可以使用phpdoc @method。您可以将此方法用于常用模型,也可以为代码生成器创建新模板。

    /**
     * @method Member findByPk($pk,$condition='',$params=array())
     */
    class Member extends CActiveRecord
    {