Article::getParameters() - Code Metrics - Inspection of "Add Article Parameters." - flatplanapp/flatplan-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( c7687a...c4355d )

by Jon
created 2021-01-30 08:59 UTC
Article::getParameters() A

↳ Parent: Article
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
<?php namespace FlatPlan;

use FlatPlan\Components\AbstractComponent;

class Article {

    private $components = array();
    private $status;
    private $article_id;
    private $title;
    private $sub_title;
    private $language = 'en';
    private $category;
    private $template;
    private $metaData = null;
    private $parameters = null;
    private $allowedMetaKeys = array(
        'authors' => 'array',
        'canonicalURL' => 'uri',
        'coverArt' => 'array',
        'dateCreated' => 'datetime',
        'dateModified' => 'datetime',
        'datePublished' => 'datetime',
        'excerpt' => 'string',
        'keywords' => 'array',
        'links' => 'array',
        'thumbnailURL' => 'uri',
        'transparentToolbar' => 'boolean',
        'videoURL' => 'uri',
        'accessoryText' => 'string',
        'isCandidateToBeFeatured' => 'boolean',
        'isHidden' => 'boolean',
        'isPreview' => 'boolean',
        'isSponsored' => 'boolean',
        'maturityRating' => 'string'
    );
    private $allowedParameters = array(
        'accessoryText' => 'string',
        'isCandidateToBeFeatured' => 'boolean',
        'isHidden' => 'boolean',
        'isPreview' => 'boolean',
        'isSponsored' => 'boolean',
        'maturityRating' => 'string',
        'targetTerritoryCountryCodes' => 'string'
    );

    public function __construct($articleId, $status = 'draft')
    {
        $this->article_id = $articleId;
        $this->status    = $status;
    }

    public function setTitle($title) {
        $this->title = $title;
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function setSubTitle($subTitle) {
        $this->sub_title = $subTitle;
    }

    public function getSubTitle()
    {
        return $this->sub_title;
    }

    public function setLanguage($language)
    {
        $this->language = $language;
    }

    public function getLanguage()
    {
        return $this->language;
    }

    public function setCategory($category)
    {
        $this->category = $category;
    }

    public function getCategory()
    {
        return $this->category;
    }

    public function setTemplate($template)
    {
        $this->template = $template;
    }

    public function getTemplate()
    {
        return $this->template;
    }

    public function setMetaData($metaData)
    {
        $metaObj = $this->getMetaData();
        if (is_null($metaObj)) {
            $metaObj = new \stdClass();
        }

        $errors  = array();
        if (is_array($metaData)) {
            foreach ($metaData as $key => $value) {
                if (isset($this->allowedMetaKeys[$key])) {
                    $type = gettype($value);
                    switch ($this->allowedMetaKeys[$key]) {
                        case 'uri':
                            if (substr($value, 0, 4) === 'http') {
                                $metaObj->{$key} = $value;
                            } else {
                                $errors[] = array(
                                    'key' => $key,
                                    'message' => 'Not a valid URI'
                                );
                            }
                            break;

                        case 'datetime':
                            if ($value instanceof \DateTime) {
                                $metaObj->{$key} = $value->format('c');
                            } else {
                                $errors[] = array(
                                    'key' => $key,
                                    'message' => 'Not a valid DateTime object'
                                );
                            }
                            break;

                        case 'array':
                            if (is_array($value)) {
                                $metaObj->{$key} = $value;
                            } else {
                                $errors[] = array(
                                    'key' => $key,
                                    'message' => 'Not a valid Array'
                                );
                            }
                            break;

                        default:
                            if ($type === $this->allowedMetaKeys[$key]) {
                                $metaObj->{$key} = $value;
                            } else {
                                $errors[] = array(
                                    'key' => $key,
                                    'message' => 'Expected ' . $this->allowedMetaKeys[$key] . '; received ' . $type
                                );
                            }
                            break;
                    }
                } else {
                    $errors[] = array(
                        'key' => $key,
                        'message' => 'Not a valid MetaData key'
                    );
                }
            }
        }

        if (!empty($errors)) {
            throw new \ErrorException('Invalid MetaData: ' . print_r($errors, true));
            throw new \ErrorException('Invalid MetaData: ' . /** @scrutinizer ignore-type */ print_r($errors, true));
        }

        $this->metaData = $metaObj;
    }

    public function getMetaData()
    {
        return $this->metaData;
    }

    public function setParameters($parameters)
    {
        $parameterObj = $this->getParameters();
        if (is_null($parameterObj)) {
            $parameterObj = new \stdClass();
        }

        $errors = array();
        if (is_array($parameters)) {
            foreach ($parameters as $key => $value) {
                if (isset($this->allowedParameters[$key])) {
                    $type = gettype($value);
                    if ($type === $this->allowedMetaKeys[$key]) {
                        $parameterObj->{$key} = $value;
                    } else {
                        $errors[] = array(
                            'key' => $key,
                            'message' => 'Expected ' . $this->allowedParameters[$key] . '; received ' . $type
                        );
                    }
                } else {
                    $errors[] = array(
                        'key' => $key,
                        'message' => 'Not a valid Parameter'
                    );
                }
            }
        }

        if (!empty($errors)) {
            throw new \ErrorException('Invalid Parameters: ' . print_r($errors, true));
            throw new \ErrorException('Invalid Parameters: ' . /** @scrutinizer ignore-type */ print_r($errors, true));
        }

        $this->parameters = $parameterObj;
    }

    public function getParameters()
    {
        return $this->parameters;
    }

    public function getJson()
    {
        $article              = new \stdClass();
        $article->article_id  = $this->article_id;
        $article->language    = $this->getLanguage();
        $article->status      = $this->status;
        $article->title       = $this->getTitle();
        $article->sub_title   = $this->getSubTitle();
        $article->category    = $this->getCategory();
        $article->template    = $this->getTemplate();
        $article->metadata    = $this->getMetaData();
        $article->parameters  = $this->getParameters();
        $article->components  = $this->getComponents();

        return json_encode($article, JSON_UNESCAPED_UNICODE);
    }

    public function getComponents($format = null)
    {
        $output = array();
        foreach ($this->components as $component) {
            array_push($output, $component->getComponent());
        }

        if ($format === 'json') {
            return json_encode($output, JSON_UNESCAPED_UNICODE);
        }

        return $output;
    }

    /**
     * @param AbstractComponent $component
     * @throws \ErrorException
     * @return void
     */
    public function setComponents($components)
    {
        if (is_array($components)) {
            foreach ($components as $component) {
                if ($component instanceof AbstractComponent && !is_null($component->getRole())) {
                    $component->updateStyles('root');
                    array_push($this->components, $component);
                }
            }
        } else if ($components instanceof AbstractComponent && !is_null($components->getRole())) {
            $components->updateStyles('root');
            array_push($this->components, $components);
        }
    }
}

flatplanapp / flatplan-sdk

Push — master ( c7687a...c4355d )

Article::getParameters() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
