jii/data/ModelAttributeSchema.js

Jii - Full-Stack JavaScript Framework

/**
 * @author <a href="http://www.affka.ru">Vladimir Kozhin</a>
 * @license MIT
 */

'use strict';

const Jii = require('../BaseJii');
const Expression = require('../data/Expression');
const _isBoolean = require('lodash/isBoolean');
const _isEmpty = require('lodash/isEmpty');
const BaseObject = require('../base/BaseObject');

class ModelAttributeSchema extends BaseObject {

    preInit() {
        /**
         * @var {boolean} whether this column is a primary key
         */
        this.isPrimaryKey = false;

        /**
         * @var {*} default value of this column
         */
        this.defaultValue = null;

        /**
         * @var {string} the JS type of this column. Possible JS types include:
         * string, boolean, number, double.
         */
        this.jsType = null;

        /**
         * @var {string} abstract type of this column. Possible abstract types include:
         * string, text, boolean, smallint, integer, bigint, float, decimal, datetime,
         * timestamp, time, date, binary, and money.
         */
        this.type = null;

        /**
         * @var {string} name of this column (without quotes).
         */
        this.name = null;

        super.preInit(...arguments);
    }

    /**
     * Converts the input value according to [[jsType]].
     * If the value is null or an [[Expression]], it will not be converted.
     * @param {*} value input value
     * @return {*} converted value
     */
    typecast(value) {
        if (value === '' && [
                'text',
                'string',
                'binary'
            ].indexOf(this.type) === -1) {
            // TODO Use const values from BaseSchema
            return null;
        }

        // @todo php->js types
        if (value === null || typeof value === this.jsType || value instanceof Expression) {
            return value;
        }

        switch (this.jsType) {
            case 'string':
                return String(value);

            case 'number':
                return _isBoolean(value) ? value ? 1 : 0 : parseFloat(value);

            case 'boolean':
                return !!value;
        }

        return value;
    }

    toJSON() {
        var obj = {};

        if (this.defaultValue !== null) {
            obj.defaultValue = this.defaultValue;
        }
        if (this.isPrimaryKey) {
            obj.isPrimaryKey = this.isPrimaryKey;
        }
        if (this.jsType !== null) {
            obj.jsType = this.jsType;
        }
        if (this.name !== null) {
            obj.name = this.name;
        }

        if (_isEmpty(obj)) {
            return this.type;
        }

        if (this.type !== null) {
            obj.type = this.type;
        }
        return obj;
    }

}
module.exports = ModelAttributeSchema;