Solvire\API\JSONSchema\Base

Complexity

Total Complexity

18

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

89.8%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	4
A	setName()	0	4	1
A	setId()	0	4	1
A	setVersion()	0	4	1
A	setBaseUrl()	0	4	1
A	setBasePath()	0	4	1
A	setDocumentationUrl()	0	4	1
A	setDescription()	0	4	1
B	allSet()	0	13	6
A	toSchema()	0	15	1

<?php
namespace Solvire\API\JSONSchema;

use Solvire\Utilities\OptionsChecker as Ch;
use Solvire\Application as Ev;

/**
 * Base of the schema
 * 
 * @author solvire <info@scotttactical.com>
 * @package JSONSchema
 * @namespace Solvire\API\JSONSchema
 */
class Base implements Schemable
{

    /**
     * basically application name
     * 
     * @var string $name
     */
    protected $name = null;

    /**
     *
     * @var string
     */
    protected $id = null;

    /**
     *
     * @var string
     */
    protected $version = null;

    /**
     *
     * @var string
     */
    protected $baseUrl = null;

    /**
     *
     * @var string
     */
    protected $basePath = null;

    /**
     *
     * @var string
     */
    protected $documentationUrl = null;

    /**
     *
     * @var string
     */
    protected $description = null;

    /**
     *
     * @var array $mandatoryFields
     */
    protected $mandatoryFields = [
        'id',
        'baseUrl',
        'basePath',
        'documentationUrl',
        'version',
        'description'
    ];

    /**
     *
     * @param array $options            
     */
    public function __construct(array $options = null)
    {
        if (isset($options)) {
            foreach ($options as $key => $value) {
                if (method_exists(self, $key))
                    $this->$key = $value;
            }
        }
    }

    /**
     *
     * @param string $name            
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    public function setId($id)
    {
        $this->id = $id;
    }

    public function setVersion($version)
    {
        $this->version = $version;
    }

    /**
     *
     * @param string $baseUrl            
     */
    public function setBaseUrl($baseUrl)
    {
        $this->baseUrl = $baseUrl;
    }

    /**
     *
     * @param string $basePath            
     */
    public function setBasePath($basePath)
    {
        $this->basePath = $basePath;
    }

    /**
     *
     * @param string $documentationUrl            
     */
    public function setDocumentationUrl($documentationUrl)
    {
        $this->documentationUrl = $documentationUrl;
    }

    /**
     *
     * @param string $description            
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

    /**
     *
     *
     * (non-PHPdoc)
     * 
     * @see \Solvire\API\JSONSchema\Schemable::allSet()
     * @return s true or blows up
     */
    public function allSet()
    {
        $errors = [];
        foreach ($this->mandatoryFields as $field) {
            if (! isset($this->$field) || $this->$field === null || $this->$field === '')
                $errors[$field] = "Error the field: $field must be set in Base.";
        }
        
        if (count($errors))
            throw new \RuntimeException('Errors . ' . print_r($errors, 1));
        
        return true;
    }

    /**
     * dish it up
     * (non-PHPdoc)
     * 
     * @see \Solvire\API\JSONSchema\Schemable::toSchema()
     */
    public function toSchema()
    {
        $this->allSet();
        
        return [
            'id' => $this->id,
            'basePath' => $this->basePath,
            'baseUrl' => $this->baseUrl,
            'documentationUrl' => $this->documentationUrl,
            'name' => $this->name,
            '$schema' => 'http://json-schema.org/draft-04/schema#',
            'version' => $this->version,
            'description' => $this->description
        ];
    }
}