csphere\core\rad\Base

Complexity

Total Complexity

22

Size/Duplication

Total Lines	289
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	2
A	map()	0	14	3
B	message()	0	27	2
B	view()	0	26	5
B	breadcrumb()	0	32	4
A	form()	0	15	2
A	callData()	0	13	2
A	callRecord()	0	13	2

<?php

/**
 * Patterns for usual plugin actions
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   RAD
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\rad;

/**
 * Patterns for usual plugin actions
 *
 * @category  Core
 * @package   RAD
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

abstract class Base
{
    /**
     * Plugin name
     **/
    protected $plugin = '';

    /**
     * Database table name
     **/
    protected $table = '';

    /**
     * Database schema name
     **/
    protected $schema = '';

    /**
     * Action name
     **/
    protected $action = '';

    /**
     * Template file name
     **/
    protected $tpl = '';

    /**
     * Service Loader object
     **/
    protected $loader = null;

    /**
     * View driver object
     **/
    protected $view = null;

    /**
     * Previous action
     **/
    protected $previous = 'list';

    /**
     * Data closure
     **/
    private $_data = null;

    /**
     * Record closure
     **/
    private $_record = null;

    /**
     * Prepare database specific settings
     *
     * @param string $plugin Plugin name
     * @param string $table  Database table name if it differs from plugin name
     *
     * @return \csphere\core\rad\Base
     **/

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

There must be no blank lines after the function comment

    public function __construct($plugin, $table = '')
    {
        // Set class options
        $this->plugin = $plugin;
        $this->table = $table;
        $this->schema = $plugin;

        if (!empty($table)) {

            $this->schema .= '_' . $table;
        }

        // Get important objects
        $this->loader = \csphere\core\service\Locator::get();
        $this->view = $this->loader->load('view');
    }

    /**
     * Set template specific settings
     *
     * @param string $action   Action name if it differs from method name
     * @param string $tpl      Template file name
     * @param string $previous Adds the previous action to breadcrumb
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    public function map($action = '', $tpl = '', $previous = '')
    {
        $this->action = $action;
        $this->tpl = $tpl;
        $this->previous = ($previous == '') ? 'list' : $previous;

        // Manage should be handled like list
        if ($action == 'manage') {

            $this->previous = 'manage';
        }

        return true;
    }

    /**
     * If only a message is required for output
     *
     * @param string  $key  Key for translation in default plugin
     * @param integer $rid  Record ID if important for URL
     * @param string  $type Type of message: default, red, green
     *
     * @return void
     **/

There must be no blank lines after the function comment

    protected function message($key, $rid = 0, $type = 'default')
    {
        // Get message and action from translation
        $msg = \csphere\core\translation\Fetch::key('default', $key);
        $act = \csphere\core\translation\Fetch::exists('default', $this->action);

        $plugin = ($act == true) ? 'default' : $this->plugin;

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

        $act = \csphere\core\translation\Fetch::key($plugin, $this->action);
        $plg = \csphere\core\translation\Fetch::key($this->plugin, $this->plugin);

        $previous = \csphere\core\url\Link::href(
            $this->plugin, $this->previous
        );

        // Data array
        $data = ['action_name' => $act,
            'plugin_name' => $plg,
            'message' => $msg,
            'previous' => $previous,
            'type' => $type];

        // Change template file and send to view method
        $this->tpl = 'message';

        $this->view($data, $rid, true);
    }

    /**
     * Send data array to template file
     *
     * @param array   $data       Data as an array
     * @param integer $rid        Record ID if important for URL
     * @param boolean $skip       Whether to skip the callback
     * @param boolean $breadcrumb Activate Breadcrumb
     *
     * @return void
     **/

There must be no blank lines after the function comment

    protected function view(array $data, $rid = 0, $skip = false,
        $breadcrumb = false
    ) {

        if ($breadcrumb) {
            // Set breadcrumb
            $this->breadcrumb($rid);
        }

        // Set plugin and action
        $data['plugin'] = $this->plugin;
        $data['action'] = $this->action;

        // Apply registered closure
        if ($skip != true && is_callable($this->_data)) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison !== instead.

            $func = call_user_func($this->_data, $data[$this->schema]);

            $data[$this->schema] = $func;
        }

        $plugin = $this->tpl == 'message' ? 'default' : $this->plugin;

        // Pass data to template
        $this->view->template($plugin, $this->tpl, $data);
    }

    /**
     * Generate breadcrumb navigation
     *
     * @param integer $rid Record ID if important for URL
     *
     * @return void
     **/

There must be no blank lines after the function comment

    protected function breadcrumb($rid = 0)
    {
        // All actions that depend on manage get an admin link
        if ($this->previous == 'manage') {

            $bread = new \csphere\core\template\Breadcrumb('admin');
            $bread->add('content');
            $bread->plugin($this->plugin, 'manage');

        } else {

            $bread = new \csphere\core\template\Breadcrumb($this->plugin);
            $bread->plugin($this->plugin, $this->previous);
        }

        // Just add an additional link if action and previous action differ
        if ($this->previous != $this->action) {

            $url = $this->plugin . '/' . $this->action;

            // Requests for a specific ID must contain it here
            if (!empty($rid)) {

                $url .= '/id/' . (int)$rid;
            }

            // Add current action
            $bread->add($this->action, $url);
        }

        $bread->trace();
    }

    /**
     * Record data should be replaced with new content of form submit
     *
     * @param array $record Record as an array
     * @param array $new    New content as an array
     *
     * @return array
     **/

There must be no blank lines after the function comment

    protected function form(array $record, array $new)
    {
        // Move new data into record array
        $record = array_merge($record, $new);

        unset($record['csphere_form']);

        // Apply registered closure
        if (is_callable($this->_record)) {

            $record = call_user_func($this->_record, $record);
        }

        return $record;
    }

    /**
     * Set closure for template data
     *
     * @param \Closure $closure Closure
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    public final function callData($closure)
    {
        $result = false;

        if ($closure instanceof \Closure) {

            $this->_data = $closure;

            $result = true;
        }

        return $result;
    }

    /**
     * Set closure for record data before persistency gets involved
     *
     * @param \Closure $closure Closure
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    public final function callRecord($closure)
    {
        $result = false;

        if ($closure instanceof \Closure) {

            $this->_record = $closure;

            $result = true;
        }

        return $result;
    }
}