Explanation

Complexity

Total Complexity

9

Size/Duplication

Total Lines	54
Duplicated Lines	38.89 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	forTemplate()	0	5	1
B	parse_shortcode()	21	21	7
A	shortcode_attribute_fields()	0	4	1

<?php

class Explanation extends Abbreviation implements Shortcodable

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{


    private static $singular_name = 'Explanation';

Consider using a different property name as you override a private property of the parent class.

The property $singular_name is not used and could be removed.

    private static $plural_name = 'Explanations';

Consider using a different property name as you override a private property of the parent class.

The property $plural_name is not used and could be removed.

    public function forTemplate()
    {
        $template = new SSViewer('Explanation');
        return $template->process($this);
    }

    /**
     * Parse the shortcode and render as a string, probably with a template
     * @param array $arguments the list of attributes of the shortcode
     * @param string $content the shortcode content
     * @param ShortcodeParser $parser the ShortcodeParser instance
     * @param string $shortcode the raw shortcode being parsed
     * @return String

Should the return type not be null|HTMLText?

     **/
    public static function parse_shortcode($arguments, $content, $parser, $shortcode)

This method seems to be duplicated in your project.

    {
        if (empty($arguments['id'])) {
            return;
        }

        if (array_key_exists('id', $arguments) && $arguments['id']) {
            $explanation = Explanation::get()->byID($arguments['id']);
        }

        if (!$explanation) {

The variable $explanation does not seem to be defined for all execution paths leading up to this point.

            return;
        }

        if (array_key_exists('title', $arguments) && $arguments['title']) {
            $explanation->Title = $arguments['title'];
        }

        $template = new SSViewer('ExplanationShortcode');
        return $template->process($explanation);
    }

    /**
     * returns a list of fields for editing the shortcode's attributes
     * @return Fieldlist

Should the return type not be FieldList|null?

     **/
    public static function shortcode_attribute_fields()
    {
        //@todo use addnew field to add a new abbr. on the fly
    }
}