jii-model/base/ModelSchema.js

Jii model

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


'use strict';

var Jii = require('jii');
var InvalidConfigException = require('jii/exceptions/InvalidConfigException');
var ModelAttributeSchema = require('../base/ModelAttributeSchema');
var _isString = require('lodash/isString');
var _isNumber = require('lodash/isNumber');
var _isObject = require('lodash/isObject');
var _isEmpty = require('lodash/isEmpty');
var _each = require('lodash/each');
var _has = require('lodash/has');
var _keys = require('lodash/keys');
var Object = require('jii/base/Object');

/**
 * @class Jii.base.ModelSchema
 * @extends Jii.base.Object
 */
var ModelSchema = Jii.defineClass('Jii.base.ModelSchema', /** @lends Jii.base.ModelSchema.prototype */{

	__extends: Object,

    __static: /** @lends Jii.base.ModelSchema */{

        /**
         *
         * @param {object} obj
         * @returns {Jii.base.ModelSchema}
         */
        createFromObject(obj) {
            if (_isString(obj.primaryKey)) {
                obj.primaryKey = [obj.primaryKey];
            }

            _each(obj.columns, (column, name) => {
                if (!(column instanceof ModelAttributeSchema)) {
                    if (_isString(column)) {
                        if (_isNumber(name)) {
                            var parts = column.split(':');
                            column = {
                                name: parts[0],
                                type: 'string'
                            };
                        } else {
                            column = {
                                name: name,
                                type: column
                            }
                        }
                    }

                    if (!_isObject(column)) {
                        throw new InvalidConfigException('Invalid column format: ' + column);
                    }
                    if (!_isString(name)) {
                        column.name = name;
                    }
                    obj.columns[name] = new ModelAttributeSchema(column);
                }
            });

            return new this.__static(obj);
        }

    },

	/**
	 * @var {string} the name of the schema that this table belongs to.
	 */
	schemaName: '',

	/**
	 * @var {string[]} primary keys of this table.
	 */
	primaryKey: [],

	/**
	 * @var {{string: Jii.base.ModelAttributeSchema}} column metadata of this table. Each array element is a [[Jii.base.ModelAttributeSchema]] object, indexed by column names.
	 */
	columns: {},

	/**
	 * Gets the named column metadata.
	 * This is a convenient method for retrieving a named column even if it does not exist.
	 * @param {string} name column name
	 * @return {Jii.base.ModelAttributeSchema} metadata of the named column. Null if the named column does not exist.
	 */
	getColumn(name) {
		return _has(this.columns, name) ? this.columns[name] : null;
	},

	/**
	 * Returns the names of all columns in this table.
	 * @return {[]} list of column names
	 */
	getColumnNames() {
		return _keys(this.columns);
	},

    toJSON() {
        var obj = {};

        if (!_isEmpty(this.primaryKey)) {
            obj.primaryKey = this.primaryKey;
        }
        if (!_isEmpty(this.schemaName)) {
            obj.schemaName = this.schemaName;
        }
        if (!_isEmpty(this.columns)) {
            obj.columns = {};
            _each(this.columns, (column, name) => {
                obj.columns[name] = column.toJSON();
            });
        }

        return obj;
    }

});

module.exports = ModelSchema;