2017-01-06 16:57:03 +01:00
|
|
|
<?php
|
|
|
|
/*
|
|
|
|
* This file is part of the Magallanes package.
|
|
|
|
*
|
|
|
|
* (c) Andrés Montañez <andres@andresmontanez.com>
|
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Mage\Task\BuiltIn\FS;
|
|
|
|
|
2017-01-07 05:53:57 +01:00
|
|
|
use Mage\Task\Exception\ErrorException;
|
2017-01-06 16:57:03 +01:00
|
|
|
use Mage\Task\AbstractTask;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* File System Task - Abstract Base class for File Operations
|
|
|
|
*
|
|
|
|
* @author Andrés Montañez <andresmontanez@gmail.com>
|
|
|
|
*/
|
|
|
|
abstract class AbstractFileTask extends AbstractTask
|
|
|
|
{
|
2017-01-08 06:25:40 +01:00
|
|
|
/**
|
|
|
|
* Returns the Task options
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
* @throws ErrorException
|
|
|
|
*/
|
2017-01-06 16:57:03 +01:00
|
|
|
protected function getOptions()
|
|
|
|
{
|
|
|
|
$mandatory = $this->getParameters();
|
|
|
|
|
|
|
|
foreach ($mandatory as $parameter) {
|
|
|
|
if (!array_key_exists($parameter, $this->options)) {
|
2017-01-07 05:53:57 +01:00
|
|
|
throw new ErrorException(sprintf('Parameter "%s" is not defined', $parameter));
|
2017-01-06 16:57:03 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->options;
|
|
|
|
}
|
|
|
|
|
2017-01-08 06:25:40 +01:00
|
|
|
/**
|
|
|
|
* Returns the mandatory parameters
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
2017-01-06 16:57:03 +01:00
|
|
|
abstract protected function getParameters();
|
|
|
|
|
2017-01-08 06:25:40 +01:00
|
|
|
/**
|
|
|
|
* Returns a file with the placeholders replaced
|
|
|
|
*
|
|
|
|
* @param string $file
|
|
|
|
* @return string
|
|
|
|
* @throws ErrorException
|
|
|
|
*/
|
2017-01-06 16:57:03 +01:00
|
|
|
protected function getFile($file)
|
|
|
|
{
|
|
|
|
$mapping = [
|
|
|
|
'%environment%' => $this->runtime->getEnvironment(),
|
|
|
|
];
|
|
|
|
|
|
|
|
if ($this->runtime->getWorkingHost()) {
|
|
|
|
$mapping['%host%'] = $this->runtime->getWorkingHost();
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($this->runtime->getReleaseId()) {
|
|
|
|
$mapping['%release%'] = $this->runtime->getReleaseId();
|
|
|
|
}
|
|
|
|
|
|
|
|
$options = $this->getOptions();
|
|
|
|
return str_replace(
|
|
|
|
array_keys($mapping),
|
|
|
|
array_values($mapping),
|
|
|
|
$options[$file]
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|