DynamicForm.php

<?php

namespace enigmatix\dynamicforms;

use enigmatix\uuid\UUIDBehavior;
use yii\base\InvalidCallException;
use \yii\helpers\Inflector;
use Yii;
use yii\behaviors\BlameableBehavior;
use yii\db\ActiveRecord;
use yii\behaviors\TimestampBehavior;
use yii\helpers\ArrayHelper;
use yii\helpers\Json;
use yii\helpers\StringHelper;



/**
 * This is the model class for table "{{%dynamic_form}}".
 *
 * @property integer $id
 * @property string $uuid
 * @property string $form_object
 * @property string $form_data
 * @property integer $updated_at
 * @property integer $created_at
 * @property integer $owned_by
 * @property integer $created_by
 * @property integer $updated_by
 *
 * @property User $updatedBy
 * @property User $createdBy
 * @property User $ownedBy
 */
class DynamicForm extends ActiveRecord
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return '{{%dynamic_form}}';
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['form_data'], 'string'],
            [['form_data'], 'validateFormDataDefault',  'skipOnEmpty' => false, 'skipOnError' => false],
            [['form_data'], 'validateJson'],
            [['owned_by'], 'integer'],
            [['uuid', 'form_object'], 'string', 'max' => 255],
            [['owned_by'], 'exist', 'skipOnError' => true, 'targetClass' => $this->getUserClass(), 'targetAttribute' => ['owned_by' => 'id']],
        ];
    }

    public function behaviors()
    {
        return [
            TimestampBehavior::className(),
            BlameableBehavior::className(),
            UUIDBehavior::className(),
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'id' => Yii::t('app', 'ID'),
            'uuid' => Yii::t('app', 'Uuid'),
            'form_object' => Yii::t('app', 'Form Object'),
            'form_data' => Yii::t('app', 'Form Data'),
            'updated_at' => Yii::t('app', 'Updated At'),
            'created_at' => Yii::t('app', 'Created At'),
            'owned_by' => Yii::t('app', 'Owned By'),
            'created_by' => Yii::t('app', 'Created By'),
            'updated_by' => Yii::t('app', 'Updated By'),
        ];
    }

    public function validateJson(){
        try{
            $this->form_data;
            $decoded = Json::decode($this->form_data);

        } catch (\Exception $e){
            $this->addError('form_data', 'Element does not contain valid JSON');
            return false;
        }

        foreach ($decoded as &$field){
            $field['name'] = str_replace('-','_',$field['name']);
        }

        $this->form_data = Json::encode($decoded);

        return true;
    }

    public function validateFormDataDefault($attribute, $params, $validator){

        if ($this->form_data === null){
            $this->form_data = json_encode([
                static::textarea('Notes'),
            ]);
        }
        return true;
    }

    /**
     * @inheritdoc
     */
    public function relations()
    {
        return [
            'CreatedBy' => 'one',
            'OwnedBy'   => 'one',
            'UpdatedBy' => 'one',
        ];
    }


    /**
     * @return \yii\db\ActiveQuery
     */
    public function getCreatedBy()
    {
        return $this->hasOne($this->getUserClass(), ['id' => 'created_by']);
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getOwnedBy()
    {
        return $this->hasOne($this->getUserClass(), ['id' => 'owned_by']);
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getUpdatedBy()
    {
        return $this->hasOne($this->getUserClass(), ['id' => 'created_by']);
    }

    protected function getUserClass()
    {
        return ArrayHelper::getValue(Yii::$app, 'user.identityClass');
    }

    /**
     * @param      $modelName
     * @param null $user
     *
     * @return DynamicForm[]
     */
    public static function getModelConfig($modelName, $user = null, $account = null)
    {
        $results    = [];

        if($user !== null){
            $custom = static::findOne(['form_object' => $modelName, 'owned_by' => $user]);
            if($custom !== null){
                $results[] = $custom;
            }
        }

        if($account !== null){
            $custom = static::findOne(['form_object' => $modelName, 'account_id' => $account]);
            if($custom !== null){
                $results[] = $custom;
            }
        }

        $default = static::findOne(['form_object' => $modelName, 'owned_by' => null, 'account_id' => null]);
        if($default !== null){
            $results[]  = $default;
        }

        if(count($results) === 0){
            $newModel = new static;
            $newModel->validate(); //Generate defaults
            $results[] = $newModel;
        }

        return $results;
    }

    public static function getModelFields($model, $user = null, $account = null, $filter = null){
        $configurations = static::getModelConfig(StringHelper::basename($model->className()), $user, $account);
        $fields = [];
        foreach ($configurations as $configuration){
            $fields = ArrayHelper::merge($fields, static::getFieldNamesFromConfig($configuration->form_data, $filter));
        }

        return $fields;

    }

    public static function getModelFieldConfigurations ($model, $user, $account = null)
    {
        $config = static::getModelConfig(StringHelper::basename($model->className()), $user, $account);
        $fields = [];
        foreach ($config as $configuration){
            $fields = ArrayHelper::merge($fields, static::getFieldsConfigurationsFromConfig($configuration->form_data));
        }

        return $fields;

    }

    public static function getModelDropdownValueLabel($model, $attribute, $user = null, $account = null)
    {
        $configurations = static::getModelConfig(StringHelper::basename($model->className()), $user, $account);
        foreach ($configurations as $configuration) {
            $field = static::getFieldFromConfig($configuration->form_data,$attribute);
            if($field === null){
                continue;
            }
            foreach ($field['values'] as $value){
                if($value['value'] === $model->$attribute){
                    return $value['label'];
                }
            }
        }
    }

    public function getFormData()
    {
        return Json::decode($this->form_data);
    }

    public static function getFieldFromConfig($config, $field) {

        foreach (Json::decode($config) as $node) {
            if($node['name'] === $field){
                return $node;
            }
        }
    }

    public static function getFieldOptionsFromConfig($config, $filter)
    {
        return static::getFieldAttributeFromConfig($config, 'values', $filter);
    }

    public static function getDropdownValueLabel($config, $field, $value)
    {
        $values = static::getFieldOptionsFromConfig($config, $field);

        return $values[$value];
    }

    public static function getFieldNamesFromConfig($config, $filter = null)
    {
        return static::getFieldAttributeFromConfig($config, 'name', $filter);
    }

    public static function getFieldsConfigurationsFromConfig($config)
    {
        return Json::decode($config);
    }

    public static function getFieldLabelsFromConfig($config, $filter = null)
    {
        return static::getFieldAttributeFromConfig($config, 'label', $filter);
    }
    public static function getFieldAttributeFromConfig($config, $attribute, $filter = null)
    {
        $fields = [];

        foreach (Json::decode($config) as $field){
            if($filter !== null){
                if(is_string($filter)){
                    if(ArrayHelper::getValue($field, $filter) === null){
                        continue;
                    }
                } else if (is_callable($filter)) {
                    if(!call_user_func($filter, $field)){
                        continue;
                    }
                }
            }
            $name           = $field['name'];
            $value          = $field[$attribute];
            $fields[$name]  = $value;
        }

        return $fields;
    }

    public static function getDetailStringsFromConfig($config)
    {
        $return = [];
        $fields = Json::decode($config);
        foreach ($fields as $field){
            $name = $field['name'];

            if(array_search($name, $return) === false){
                $return[] = static::getFieldDisplayString($name, $field);
            }
        }

        return $return;
    }

    public static function getModelDetailStrings($model, $user = null, $account = null){
        $configurations = static::getModelConfig(StringHelper::basename($model->className()), $user, $account);
        $fields = [];
        foreach ($configurations as $configuration){
            $fields = ArrayHelper::merge($fields, static::getDetailStringsFromConfig($configuration->form_data));
        }

        return array_values($fields);

    }

    public static function getModelLabels($model, $user = null, $account = null )
    {

        $configurations = static::getModelConfig(StringHelper::basename($model->className()), $user, $account);
        $fields = [];
        foreach ($configurations as $configuration){
            $fields = ArrayHelper::merge($fields, static::getFieldLabelsFromConfig($configuration->form_data));
        }

        return $fields;

    }

    public static function getFieldDisplayString($name, $fieldConfig)
    {
        switch ($fieldConfig['type']) {
            case 'textarea':
                return static::getFieldDisplayAttribute($name, $fieldConfig) . ':html:' . $fieldConfig['label'];
            case 'checkbox-group':
            case 'dropdown':
                return static::getFieldDisplayAttribute($name, $fieldConfig) . ':html:' . $fieldConfig['label'];
            case 'select':
                return static::getFieldDisplayAttribute($name, $fieldConfig) . ':text:' . $fieldConfig['label'];
            case 'file':
            case 'link':
            case 'url':
                return static::getFieldDisplayAttribute($name, $fieldConfig) . ':url:' . $fieldConfig['label'];
            default:
                return static::getFieldDisplayAttribute($name, $fieldConfig) . ':text:' . $fieldConfig['label'];
        }
    }

    public static function getFieldDisplayAttribute($name, $fieldConfig)
    {
        switch ($fieldConfig['type']) {
            case 'textarea':
                return $name;
            case 'checkbox-group':
            case 'dropdown':
                return $name . 'LabelString';
            case 'select':
                return $name . 'LabelString';
            default:
                return $name;
        }
    }

    public function getFieldConfig($name)
    {

    }

    public function getFields()
    {

    }

    public function userUpdateAuthorised($user)
    {

    }

    protected static function field($type, $name, array $options = [])
    {
        $defaults = [
            'label'     => Inflector::titleize($name),
            'name'      => Inflector::underscore($name),
            'className' => 'form-control',
        ];
        switch ($type) {
            case 'textarea':
                $defaults['type']    = 'textarea';
                $defaults['subtype'] = 'text';
                break;
            case 'text':
                $defaults['type']    = 'text';
                $defaults['subtype'] = 'text';
                break;
            case 'date':
                $defaults['type']    = 'date';
                $defaults['subtype'] = 'date';
                break;
            case 'dropdown':
                $defaults['type']    = 'select';
                $values              = ArrayHelper::remove($options, 'values');
                $structuredValues    = [];
                foreach ($values as $key => $value) {
                    $structuredValues[] = ['label' => $value, 'value' => $key];
                }
                $defaults['values'] = $structuredValues;
                break;
        }

        return ArrayHelper::merge($defaults, $options);
    }

    public static function text($name, array $options = [])
    {
        return static::field('text',$name,$options);
    }

    public static function textarea($name, array $options = [])
    {
        return static::field('textarea',$name,$options);
    }

    public static function dropdown($name, array $values, array $options = []){
        return static::field('dropdown',$name,ArrayHelper::merge(['values' => $values],$options));
    }

    public static function date($name, array $options = []){
        return static::field('date', $name, $options);
    }
}