andmemasin\surveybasemodels\Survey

Complexity

Total Complexity

5

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptionsDecoded()	0	2	1
A	attributeHints()	0	4	1
A	attributeLabels()	0	8	1
A	rules()	0	8	1
A	findByKey()	0	5	1

<?php

namespace andmemasin\surveybasemodels;

use andmemasin\myabstract\ModelWithHasStatus;
use andmemasin\survey\Status;
use yii;

/**
 * This is the model class for a generic Survey. This describes common
 * parameters all Survey models must have regardless of the methodology.
 * All Surveys in multiple modes (CATI, CAPI, PANEL, WEB etc.) must extend
 * this class.
 *
 * @property int $survey_id
 * @property string $key
 * @property string $status
 * @property string $name
 * @property string $options The options as json string. Contains the Collector authentication information (or any other info)
 *
 *
 */
class Survey extends ModelWithHasStatus
{
    public static $hasStatusClassName = SurveyHasStatus::class;
    public $statusModelClass = Status::class;


    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return array_merge([
            [['name','status'], 'required'],
            [['name', 'status'], 'string', 'max' => 255],
            [['name'], 'string','max' => 500],
            [['options'], 'string','max' => 1024 * 10],
        ], parent::rules());
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return [
            'survey_id' => Yii::t('app', 'ID'),
            'name' => Yii::t('app', 'Survey name'),
            'status' => Yii::t('app', 'Status'),
            'options' => Yii::t('app', 'Options JSON'),
            'key' => Yii::t('app', 'Survey key'),
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function attributeHints()
    {
        return [
            'key' => Yii::t('app', 'Survey key is a cross-platform multi-mode unique id for survey.'),
        ];
    }

    /**
     * @return mixed
     */
    public function getOptionsDecoded(){
        return json_decode($this->options);
    }


    /**
     * @param string $key survey uuid
     * @return static|array|null|yii\db\ActiveRecord
     */
    public static function findByKey($key)
    {
        // key is a protected keyword so we need to quote it properly
        $colName = Yii::$app->db->schema->quoteColumnName("key");
        return static::find()->andWhere($colName . "=:key", [":key" => $key])->one();
    }

}