107 lines
2.1 KiB
PHP
107 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace PHPCensor;
|
|
|
|
use PHPCensor\Model\Build;
|
|
|
|
/**
|
|
* @author Dan Cryer <dan@block8.co.uk>
|
|
*/
|
|
abstract class Plugin
|
|
{
|
|
const STATUS_PENDING = 0;
|
|
const STATUS_RUNNING = 1;
|
|
const STATUS_SUCCESS = 2;
|
|
const STATUS_FAILED = 3;
|
|
const STATUS_FAILED_ALLOWED = 4;
|
|
/**
|
|
* @var \PHPCensor\Builder
|
|
*/
|
|
protected $builder;
|
|
|
|
/**
|
|
* @var \PHPCensor\Model\Build
|
|
*/
|
|
protected $build;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $options;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $priorityPath = 'local';
|
|
|
|
/**
|
|
* @param Builder $builder
|
|
* @param Build $build
|
|
* @param array $options
|
|
*/
|
|
public function __construct(Builder $builder, Build $build, array $options = [])
|
|
{
|
|
$this->builder = $builder;
|
|
$this->build = $build;
|
|
$this->options = $options;
|
|
|
|
if (!empty($options['priority_path']) && in_array($options['priority_path'], ['global', 'system'], true)) {
|
|
$this->priorityPath = $options['priority_path'];
|
|
}
|
|
|
|
$this->builder->logDebug('Plugin options: ' . json_encode($options));
|
|
}
|
|
|
|
/**
|
|
* Find a binary required by a plugin.
|
|
*
|
|
* @param array|string $binary
|
|
* @param boolean $quiet Returns null instead of throwing an exception.
|
|
*
|
|
* @return string|false
|
|
*
|
|
* @throws \Exception when no binary has been found and $quiet is false.
|
|
*/
|
|
public function findBinary($binary, $quiet = false)
|
|
{
|
|
return $this->builder->findBinary($binary, $quiet, $this->priorityPath);
|
|
}
|
|
|
|
/**
|
|
* @return Build
|
|
*/
|
|
public function getBuild()
|
|
{
|
|
return $this->build;
|
|
}
|
|
|
|
/**
|
|
* @return Builder
|
|
*/
|
|
public function getBuilder()
|
|
{
|
|
return $this->builder;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getPriorityPath()
|
|
{
|
|
return $this->priorityPath;
|
|
}
|
|
|
|
/**
|
|
* @return boolean
|
|
*/
|
|
abstract public function execute();
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public static function pluginName()
|
|
{
|
|
return '';
|
|
}
|
|
}
|