Yii:更改活动记录字段名称

时间:2014-03-24 10:47:51

标签: yii

我是Yii的新手,我有一个表'Student',其中包含'stdStudentId''stdName'等字段。 我正在制作API,所以这些数据应该以JSON格式返回。现在,因为我希望JSON中的字段名称与'id''name'类似,并且我不希望返回所有字段,我在模型中创建了一个方法:

public function APIfindByPk($id){
$student = $this->findByPk($id);
return array(
'id'=>$student->stdStudentId, 
'name'=>$student->stdName, 
'school'=>$student->stdSchool
);
}

问题是,stdSchool是一种关系,在这种情况下,$student->stdSchool会返回包含schSchoolIdschName等字段的数组。我不想要字段要像JSON中那样命名,而且我不希望返回School的所有字段,我想添加一些我自己的字段。有没有办法在Yii中执行此操作,或者我必须通过编写这样的方法手动执行此操作?

3 个答案:

答案 0 :(得分:1)

我一直在寻找同样的事情。有一个名为Fractal的伟大的php lib让你实现它:http://fractal.thephpleague.com/

为了简要解释lib,为每个模型创建一个Transformer,它将在模型属性和需要使用api公开的属性之间进行映射。

class BookTransformer extends Fractal\TransformerAbstract
{
    public function transform(Book $book)
    {
        return [
            'id' => (int) $book->id,
            'title' => $book->title,
            'year' => $book->yr,
        ];
    }
}

在变压器中,您还可以设置此模型具有的关系:

class BookTransformer extends TransformerAbstract
{
    /**
     * List of resources relations that can be used
     *
     * @var array
     */
    protected $availableEmbeds = [
        'author'
    ];

    /**
     * Turn this item object into a generic array
     *
     * @return array
     */
    public function transform(Book $book)
    {
        return [
            'id'    => (int) $book->id,
            'title' => $book->title,
            'year'  => $book->yr,
        ];
    }

    /**
     * Here we are embeding the author of the book
     * using it's own transformer
     */
    public function embedAuthor(Book $book)
    {
        $author = $book->author;

        return $this->item($author, new AuthorTransformer);
    }
}

所以最后你会打电话给

$fractal = new Fractal\Manager();
$resource = new Fractal\Resource\Collection($books, new BookTransformer);
$json = $fractal->createData($resource)->toJson();

在一个答案中描述分形的所有潜力并不容易,但你真的应该尝试一下。 我和Yii一起使用它,所以如果你有一些问题请不要犹豫!

答案 1 :(得分:0)

由于您使用Yii活动记录从数据库获取值,因此请求数据库使用列别名

普通SQL将类似于以下内容:

SELECT id AS Student_Number, name AS Student_Name, school AS School_Attending FROM student;

在Yii中,您可以将Criteria应用于findByPK()函数。请参阅此处以供参考:http://www.yiiframework.com/doc/api/1.1/CActiveRecord#findByPk-detail

$criteria = new CDbCriteria();
$criteria->select = 'id AS Student_Number';
$student = Student::model()->findByPk($id, $criteria);

请注意,为了使用这样的列别名,您必须在Student {}模型中定义虚拟属性Student_Number。

答案 2 :(得分:0)

重写ActiveRecord的populateRecord()函数即可实现!

我的 DishType 有 5 个属性并覆盖了 populateRecord 函数 Yii 会在从数据库中获取记录时调用它。

我的代码在这里!

class DishType extends ActiveRecord
{
    public $id;
    public $name;
    public $sort;
    public $createTime;
    public $updateTime;


public static function populateRecord($record, $row)
{
    $pattern = ['id' => 'id', 'name' => 'name', 'sort' => 'sort', 'created_at' => 'createTime', 'updated_at' => 'updateTime'];
    $columns = static::getTableSchema()->columns;
    foreach ($row as $name => $value) {
        $propertyName = $pattern[$name];
        if (isset($pattern[$name]) && isset($columns[$name])) {
            $record[$propertyName] = $columns[$name]->phpTypecast($value);
        }
    }
    parent::populateRecord($record, $row);
}

}