Ajde_Crud_Field - Code Metrics - nabble/ajde - Measure and Improve Code Quality continuously with Scrutinizer

Ajde_Crud_Field B
last analyzed 2016-09-18 20:02 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	254
Duplicated Lines	4.72 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes

Metric	Value
dl	12
loc	254
rs	8.3396
c	0
b	0
f	0
wmc	44
lcom	2
cbo	7

27 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	27	4
A	prepare()	0	3	1
A	getName()	0	4	1
A	getDbType()	0	4	1
A	getLabel()	0	4	1
A	getLength()	0	4	1
A	getIsRequired()	0	4	1
A	getDefault()	0	4	1
A	getIsAutoIncrement()	0	4	1
A	getIsAutoUpdate()	0	4	1
A	getIsUnique()	0	4	1
A	getValue()	0	8	2
A	getType()	0	4	1
A	getHtml()	0	7	1
A	getInput()	0	8	1
A	_getFieldTemplate()	0	4	1
A	_getInputTemplate()	0	4	1
A	_getTemplate()	5	19	4
A	_hasCustomTemplate()	7	7	1
A	_getCustomTemplateBase()	0	4	1
A	_getCustomTemplateAction()	0	4	1
A	getHtmlRequired()	0	5	1
A	getHtmlPK()	0	4	1
C	getHtmlAttributesAsArray()	0	30	8
A	getHtmlAttribute()	0	9	2
A	getHtmlAttributes()	0	13	3
A	getCrud()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Ajde_Crud_Field often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Ajde_Crud_Field, and based on these observations, apply Extract Interface, too.

<?php

abstract class Ajde_Crud_Field extends Ajde_Object_Standard
{
    /**
     * @var Ajde_Crud
     */
    protected $_crud;

    /**
     * @var string
     */
    protected $_type;

    protected $_useSpan = 12;
    protected $_attributes = [];

    public function __construct(Ajde_Crud $crud, $fieldOptions)
    {
        $explode = explode('_', get_class($this));
        end($explode);
        $this->_type = strtolower(current($explode));
        $this->_crud = $crud;

        /* defaults */
        $this->_data = [
            'name'            => isset($fieldOptions['name']) ? $fieldOptions['name'] : false,
            'type'            => 'text',
            'length'          => 255,
            'default'         => '',
            'label'           => isset($fieldOptions['name']) ? ucfirst($fieldOptions['name']) : false,
            'isRequired'      => false,
            'isPK'            => false,
            'isAutoIncrement' => false,
            'isAutoUpdate'    => false,
        ];

        /* options */
        foreach ($fieldOptions as $key => $value) {
            $this->set($key, $value);
        }

        $this->prepare();
    }

    protected function prepare()
    {
    }

    /**
     * Getters and setters.
     */
    public function getName()
    {
        return parent::getName();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getDbType()
    {
        return parent::getDbType();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getLabel()
    {
        return parent::getLabel();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getLength()
    {
        return parent::getLength();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getIsRequired()
    {
        return parent::getIsRequired();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getDefault()
    {
        return parent::getDefault();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getIsAutoIncrement()
    {
        return parent::getIsAutoIncrement();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getIsAutoUpdate()
    {
        return parent::getIsAutoUpdate();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getIsUnique()
    {
        return parent::getIsUnique();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getValue()
    {
        if (parent::hasValue()) {
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
            return parent::getValue();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        } else {
            return false;
        }
    }

    public function getType()
    {
        return $this->_type;
    }

    /**
     * Template functions.
     */
    public function getHtml()
    {
        $template = $this->_getFieldTemplate();
        $template->assign('field', $this);

        return $template->render();
    }

    public function getInput($id = null)
    {
        $template = $this->_getInputTemplate();
        $template->assign('field', $this);
        $template->assign('id', $id);

        return $template->render();
    }

    protected function _getFieldTemplate()
    {
        return $this->_getTemplate('field');
    }

    protected function _getInputTemplate()
    {
        return $this->_getTemplate('field/'.$this->_type);
    }

    protected function _getTemplate($action)
    {
        $template = null;
        if (Ajde_Template::exist(MODULE_DIR.'_core/', 'crud/'.$action) !== false) {
            $template = new Ajde_Template(MODULE_DIR.'_core/', 'crud/'.$action);
            Ajde::app()->getDocument()->autoAddResources($template);

        }
        if ($this->_hasCustomTemplate($action)) {

            $base = $this->_getCustomTemplateBase();
            $action = $this->_getCustomTemplateAction($action);
            $template = new Ajde_Template($base, $action);
        }
        if ($template instanceof Ajde_Template) {
            return $template;
        } else {
            // TODO:
            throw new Ajde_Exception('No crud template found for field '.$action);
        }
    }

    protected function _hasCustomTemplate($action)

    {
        $base = $this->_getCustomTemplateBase();
        $action = $this->_getCustomTemplateAction($action);

        return Ajde_Template::exist($base, $action) !== false;
    }

    protected function _getCustomTemplateBase()
    {
        return MODULE_DIR.$this->_crud->getCustomTemplateModule().'/';
    }

    protected function _getCustomTemplateAction($action)
    {
        return 'crud/'.(string) $this->_crud->getModel()->getTable().'/'.$action;
    }

    /**
     * HTML functions.
     */
    public function getHtmlRequired()
    {
        //return '<span class="required">*</span>';
        return '';
    }

    public function getHtmlPK()
    {
        return " <img src='".MEDIA_DIR."icons/16/key_login.png' style='vertical-align: middle;' title='Primary key' />";
    }

    public function getHtmlAttributesAsArray()
    {
        if (empty($this->_attributes)) {
            $attributes = [];
            if (method_exists($this, '_getHtmlAttributes')) {
                $attributes = $this->_getHtmlAttributes();

            }
            $attributes['name'] = $this->getName();
            if (!array_key_exists('id', $attributes)) {
                $attributes['id'] = 'in_'.$this->getName();
            }
            if ($this->hasNotEmpty('class')) {
                if (array_key_exists('class', $attributes)) {
                    $attributes['class'] .= ' '.$this->getClass();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                } else {
                    $attributes['class'] = $this->getClass();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                }
            }
            if ($this->_useSpan !== false) {
                if (array_key_exists('class', $attributes)) {
                    $attributes['class'] .= ' span'.$this->_useSpan;
                } else {
                    $attributes['class'] = 'span'.$this->_useSpan;
                }
            }
            $this->_attributes = $attributes;
        }

        return $this->_attributes;
    }

    public function getHtmlAttribute($name)
    {
        $attributes = $this->getHtmlAttributesAsArray();
        if (isset($attributes[$name])) {
            return $attributes[$name];
        }

        return false;
    }

    public function getHtmlAttributes()
    {
        $attributes = $this->getHtmlAttributesAsArray();

        $text = '';
        foreach ($attributes as $k => $v) {
            if (strlen($v)) {
                $text .= $k.'="'.$v.'" ';
            }
        }

        return $text;
    }

    /**
     * @return Ajde_Crud
     */
    public function getCrud()
    {
        return $this->_crud;
    }
}


Ajde_Crud_Field B
last analyzed 2016-09-18 20:02 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

27 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

nabble / ajde

Ajde_Crud_Field B last analyzed 2016-09-18 20:02 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

27 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

Ajde_Crud_Field B
last analyzed 2016-09-18 20:02 UTC