Helmut\Forms\Plugin

Complexity

Total Complexity

10

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

66.67%

Importance

Changes	6
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	configure()	0	9	3
A	setPath()	0	4	1
A	path()	0	5	2
A	templatePaths()	0	5	1
A	event()	0	9	2

<?php 

namespace Helmut\Forms;

use Helmut\Forms\Utility\Str;
use Helmut\Forms\Utility\Reflect;

abstract class Plugin {
	
    /**
     * Autoload path for plugin.
     *
     * @var string
     */
	protected $path;

    /**
     * Create a new plugin instance.
     *
     * @param  array  $config
     * @return void

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

     */
	public function __construct($config = null) 
	{
        $this->configure($config);

It seems like $config defined by parameter $config on line 23 can also be of type null; however, Helmut\Forms\Plugin::configure() does only seem to accept array, maybe add an additional type check?

		$this->setPath();
	}

    /**
     * Configure the plugin.
     *
     * @param  array  $config
     * @return void
     */   
    public function configure($config)
    {
        foreach ((array) $config as $key => $value) {
            $method = 'set'.Str::studly($key);
            if (method_exists($this, $method)) {
                $this->{$method}($value);
            }
        }        
    }

	/**
     * Set the plugin autoload path.
     *
     * @return void
     */
	public function setPath()
	{
        $this->path = Reflect::getDirectory($this);
	}

	/**
     * Get autoload path.
     *
     * @return string
     */
	public function path($append = null) 
	{
		return is_null($append) ? $this->path 
			: $this->path.'/'.ltrim(rtrim($append, '/'), '/').'/';
	}

	/**
     * Get paths to templates.
     *
     * @return string
     */
	public function templatePaths() 
	{
		$path = $this->path('templates');
		return [$path];
	}

	/**
     * Trigger an event callback. This allows
     * you to hook into events from within the plugin.
     * - onLoad
     * - onDefine
     * - onRender
     * - onSubmitted
     * - onCompleted
     * - onValidate
     * - onValidated
     * - onValid
     * - onInvalid
     *
	 * @param  \Helmut\Forms\Form  $form
	 * @param  string  $name
	 * @param  array  $params
     * @return mixed
     */
	public function event($form, $name, $params = []) 
	{
		$name = Str::studly($name);

		if (method_exists($this, 'on'.$name)) {
			return call_user_func_array(array($this, 'on'.$name), [$form, $params]);
		}

	}

}