Scabbia\Tasks\TaskBase

Complexity

Total Complexity

1

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	4
Bugs	1	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
	executeTask()	0	1	?
	help()	0	1	?

<?php
/**
 * Scabbia2 Tasks Component
 * https://github.com/eserozvataf/scabbia2
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @link        https://github.com/eserozvataf/scabbia2-tasks for the canonical source repository
 * @copyright   2010-2016 Eser Ozvataf. (http://eser.ozvataf.com/)
 * @license     http://www.apache.org/licenses/LICENSE-2.0 - Apache License, Version 2.0
 */

namespace Scabbia\Tasks;

use Scabbia\Formatters\FormatterInterface;

/**
 * Default methods needed for implementation of a task
 *
 * @package     Scabbia\Tasks
 * @author      Eser Ozvataf <eser@ozvataf.com>
 * @since       2.0.0
 */
abstract class TaskBase
{
    /**
     * Initializes a task
     */
    public function __construct()
    {
    }

    /**
     * Executes the task
     *
     * @param array              $uParameters  parameters
     * @param FormatterInterface $uFormatter   formatter class
     *
     * @return int exit code
     */
    abstract public function executeTask(array $uParameters, FormatterInterface $uFormatter);

    /**
     * Returns the usage form and list of available parameters
     *
     * @param FormatterInterface $uFormatter   formatter class
     *
     * @return void
     */
    abstract public function help(FormatterInterface $uFormatter);
}