dameter / survey-abstracts

src/models/Field.php

<?php
namespace dameter\abstracts\models;

use yii\base\InvalidConfigException;
use yii\base\Model;

/**
 * Class Field describes a column in responses data
 *
 * @property string $type technical type for DB
 * @property string $name fieldName - actual column name in DB
 * @property string $tokenFieldCollation the suitable collation for token field
 *
 * @package dameter\abstracts\models
 * @author Tõnis Ormisson <tonis@andmemasin.eu>
 */
class Field extends Model
{

    const TYPE_STRING = 'string';
    const TYPE_CHAR = 'char';
    const TYPE_INTEGER = 'integer';
    const TYPE_DOUBLE = 'double';
    const TYPE_DATE = 'date';
    const TYPE_DATETIME = 'datetime';

    const DEFAULT_STRING_LENGTH = 5;
    const DEFAULT_DOUBLE_LENGTH = 30;
    const DEFAULT_DOUBLE_DECIMALS = 10;

    const SYSFIELD_ID = 'id';
    const SYSFIELD_TOKEN = 'token';
    const SYSFIELD_SEED = 'seed';
    const SYSFIELD_STARTLANGUAGE = 'startlanguage';
    const SYSFIELD_STARTDATE = 'startdate';
    const SYSFIELD_SUBMITDATE = 'submitdate';
    const SYSFIELD_DATESTAMP = 'datestamp';
    const SYSFIELD_LASTPAGE = 'lastpage';
    const SYSFIELD_REFURL = 'refurl';
    const SYSFIELD_IP_ADDRESS = 'ipaddr';


    /** @var BaseQuestion */
    public $question;

    /** @var string $systemFieldName Name for non-question field */
    public $systemFieldName;


    /** @var string */
    public $id;

    /** @var bool $isCommentField  */
    public $isCommentField = false;

    /** @var bool $isOtherField  */
    public $isOtherField = false;

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        parent::init();
        if (!($this->question instanceof BaseQuestion)) {

$this->question is always a sub-type of dameter\abstracts\models\BaseQuestion. If $this->question can have other possible types, add them to src/models/Field.php:43.

            throw new InvalidConfigException();
        }
    }



    /**
     * @return string
     */
    public function getType()
    {
        if (!empty($this->question)) {
            if ($this->isCommentField || $this->isOtherField) {
                return "text";
            }
            return $this->question->questionType->fieldType;
        }
        return $this->systemFieldType();
    }


    /**
     * @return string
     * @throws \Exception
     */
    private function systemFieldType()
    {
        switch ($this->systemFieldName) {
            case self::SYSFIELD_ID:
                return "pk";
                break;

break is not strictly necessary here and could be removed.

            case self::SYSFIELD_SEED:
                return "string(31)";
                break;
            case self::SYSFIELD_STARTLANGUAGE:
                return "string(20) NOT NULL";
                break;
            case self::SYSFIELD_STARTDATE:
            case self::SYSFIELD_DATESTAMP:
                return "datetime NOT NULL";
                break;
            case self::SYSFIELD_SUBMITDATE:
                return "datetime";
                break;
            case self::SYSFIELD_LASTPAGE:
                return "integer";
                break;
            case self::SYSFIELD_TOKEN:
                return "string(36) " . $this->tokenFieldCollation;
                break;
            case self::SYSFIELD_REFURL:
                return "text";
                break;
            case self::SYSFIELD_IP_ADDRESS:
                return "string(45)";
                break;
            default:
                throw new \Exception("Undefined system column {$this->systemFieldName}");
        }
    }

    /**
     * @return string
     * @throws \Exception
     */
    public function getName()
    {
        if (!empty($this->question)) {
            return $this->question->code;
        } elseif (!empty($this->systemFieldName)) {
            return $this->systemFieldName;
        }
        throw new \Exception('Either question or systemFieldName must be defined for Field');
    }



    /**
     * @return string
     * @throws \Exception
     */
    public function getTokenFieldCollation()
    {
        $driverName = $this->getDriverName();
        if ($driverName === 'mysql') {
            return " COLLATE 'utf8mb4_bin'";
        }
        if ($driverName == 'sqlsrv' || $driverName == 'dblib' || $driverName == 'mssql') {
            return " COLLATE 'SQL_Latin1_General_CP1_CS_AS'";
        }
        throw new \Exception('Unsupported database engine ' . $driverName);
    }

    /**
     * @return string
     */
    public function getDriverName() {
        return \Yii::$app->db->driverName;
    }



}