EventEspresso\core\db_models\helpers\ModelSchema

Complexity

Total Complexity

9

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getModelSchema()	0	8	1
A	getModelSchemaForFields()	0	11	3
A	getModelSchemaForRelations()	0	18	3
A	getInitialSchemaStructure()	0	9	1
A	toJson()	0	4	1

<?php
namespace EventEspresso\core\db_models\helpers;

use EEM_Base;
use EE_Model_Field_Base;
use EE_Model_Relation_Base;

defined('EVENT_ESPRESSO_VERSION') || exit;

/**
 * This is used to generate an array that can be used to generate a schema for a given model.
 * The format for the generated array follows the structure given in the json-schema standard
 * @see http://json-schema.org
 *
 * @package    EventEspresso
 * @subpackage core\db_models\helpers
 * @author     Darren Ethier
 * @since      4.9.24.rc.018
 */
class ModelSchema
{
    /**
     * Return the schema for a given model from a given model.
     * @param \EEM_Base $model
     * @return array
     */
    public function getModelSchema(EEM_Base $model)
    {
        $schema = $this->getInitialSchemaStructure($model);
        $fields_on_model = $model->field_settings();
        $relations_on_model = $model->relation_settings();
        $schema = array_merge($schema, $this->getModelSchemaForFields($fields_on_model));
        return array_merge($schema, $this->getModelSchemaForRelations($relations_on_model));
    }


    /**
     * Get the schema for a given set of model fields.
     * @param \EE_Model_Field_Base[]     $model_fields
     * @return array
     */
    public function getModelSchemaForFields(array $model_fields)
    {
        $schema = array();
        foreach ($model_fields as $field => $model_field) {
            if (! $model_field instanceof EE_Model_Field_Base) {
                continue;
            }
            $schema['properties'][$field] = $model_field->get_schema();
        }
        return $schema;
    }


    /**
     * Get the schema for a given set of model relations
     * @param EE_Model_Relation_Base[] $relations_on_model
     */
    public function getModelSchemaForRelations(array $relations_on_model)
    {
        $schema = array(
            'relations' => array(
                'type' => 'object',
                'description' => __('Relations for this model', 'event_espresso'),
                'properties' => array(),
                'readonly' => true
            )
        );
        foreach ($relations_on_model as $model_name => $relation) {
            if (! $relation instanceof EE_Model_Relation_Base) {
                continue;
            }
            $schema['relations']['properties'][$model_name] = $relation->get_schema();
        }
        return $schema;
    }


    /**
     * Outputs the schema header for a model.
     * @param \EEM_Base $model
     * @return array
     */
    public function getInitialSchemaStructure(EEM_Base $model)
    {
        return array(
            '$schema' => 'http://json-schema.org/draft-04/schema#',
            'title' => $model->get_this_model_name(),
            'type' => 'object',
            'properties' => array()
        );
    }


    /**
     * Helper function that simply allows one to get whatever has been generated in an actual json object as opposed to
     * an array.
     * @param array $array_to_convert
     * @return bool|false|mixed|string
     */
    public function toJson($array_to_convert)
    {
        return wp_json_encode($array_to_convert);
    }
}