Plugin DocBlock clenaup.
This commit is contained in:
parent
b8443b8af7
commit
cfeeaa96b2
|
@ -33,6 +33,7 @@ class Atoum implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -62,8 +63,7 @@ class Atoum implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the Atoum plugin.
|
* {@inheritDocs}
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -57,7 +57,7 @@ class Behat implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs Behat tests.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -34,6 +34,7 @@ class Campfire implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -61,8 +62,7 @@ class Campfire implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the Campfire plugin.
|
* {@inheritDocs}
|
||||||
* @return bool|mixed
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -49,7 +49,7 @@ class CleanBuild implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes Composer and runs a specified command (e.g. install / update)
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -50,10 +50,7 @@ class Codeception implements PluginInterface, PluginZeroConfigInterface
|
||||||
protected $path;
|
protected $path;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param $stage
|
* {@inheritDocs}
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -66,7 +63,9 @@ class Codeception implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Try and find the codeception YML config file.
|
* Try and find the codeception YML config file.
|
||||||
|
*
|
||||||
* @param $buildPath
|
* @param $buildPath
|
||||||
|
*
|
||||||
* @return null|string
|
* @return null|string
|
||||||
*/
|
*/
|
||||||
public static function findConfigFile($buildPath)
|
public static function findConfigFile($buildPath)
|
||||||
|
@ -84,6 +83,7 @@ class Codeception implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -109,7 +109,7 @@ class Codeception implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs Codeception tests, optionally using specified config file(s).
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -128,8 +128,11 @@ class Codeception implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run tests from a Codeception config file.
|
* Run tests from a Codeception config file.
|
||||||
|
*
|
||||||
* @param $configPath
|
* @param $configPath
|
||||||
|
*
|
||||||
* @return bool|mixed
|
* @return bool|mixed
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
protected function runConfigFile($configPath)
|
protected function runConfigFile($configPath)
|
||||||
|
|
|
@ -34,11 +34,7 @@ class Composer implements PluginInterface, PluginZeroConfigInterface
|
||||||
protected $build;
|
protected $build;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if this plugin can be executed.
|
* {@inheritDocs}
|
||||||
* @param $stage
|
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -53,6 +49,7 @@ class Composer implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -80,7 +77,7 @@ class Composer implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes Composer and runs a specified command (e.g. install / update)
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -33,6 +33,7 @@ class CopyBuild implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -48,7 +49,7 @@ class CopyBuild implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Copies files from the root of the build directory into the target folder
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -74,6 +75,7 @@ class CopyBuild implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wipe the destination directory if it already exists.
|
* Wipe the destination directory if it already exists.
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
protected function wipeExistingDirectory()
|
protected function wipeExistingDirectory()
|
||||||
|
|
|
@ -44,6 +44,7 @@ class Email implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param \Swift_Mailer $mailer
|
* @param \Swift_Mailer $mailer
|
||||||
|
@ -60,7 +61,7 @@ class Email implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Send a notification mail.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -95,10 +96,13 @@ class Email implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Send a mail using the specified information.
|
||||||
|
*
|
||||||
* @param string $toAddress Single address to send to
|
* @param string $toAddress Single address to send to
|
||||||
* @param string[] $ccList
|
* @param string[] $ccList List of user to CC
|
||||||
* @param string $subject Email subject
|
* @param string $subject Email subject
|
||||||
* @param string $body Email body
|
* @param string $body Email body
|
||||||
|
*
|
||||||
* @return array Array of failed addresses
|
* @return array Array of failed addresses
|
||||||
*/
|
*/
|
||||||
public function sendEmail($toAddress, $ccList, $subject, $body)
|
public function sendEmail($toAddress, $ccList, $subject, $body)
|
||||||
|
@ -122,12 +126,9 @@ class Email implements PluginInterface
|
||||||
/**
|
/**
|
||||||
* Send an email to a list of specified subjects.
|
* Send an email to a list of specified subjects.
|
||||||
*
|
*
|
||||||
* @param array $toAddresses
|
* @param array $toAddresses List of destinatary of message.
|
||||||
* List of destinatary of message.
|
* @param string $subject Mail subject
|
||||||
* @param string $subject
|
* @param string $body Mail body
|
||||||
* Mail subject
|
|
||||||
* @param string $body
|
|
||||||
* Mail body
|
|
||||||
*
|
*
|
||||||
* @return int number of failed messages
|
* @return int number of failed messages
|
||||||
*/
|
*/
|
||||||
|
@ -146,6 +147,7 @@ class Email implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the list of email addresses to send to.
|
* Get the list of email addresses to send to.
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected function getEmailAddresses()
|
protected function getEmailAddresses()
|
||||||
|
@ -172,6 +174,7 @@ class Email implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the list of email addresses to CC.
|
* Get the list of email addresses to CC.
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected function getCcAddresses()
|
protected function getCcAddresses()
|
||||||
|
|
|
@ -29,6 +29,7 @@ class Env implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -41,7 +42,7 @@ class Env implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds the specified environment variables to the builder environment
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -29,6 +29,7 @@ class Git implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -41,8 +42,7 @@ class Git implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the Git plugin.
|
* {@inheritDocs}
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -72,8 +72,10 @@ class Git implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine which action to run, and run it.
|
* Determine which action to run, and run it.
|
||||||
|
*
|
||||||
* @param $action
|
* @param $action
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function runAction($action, array $options = array())
|
protected function runAction($action, array $options = array())
|
||||||
|
@ -98,6 +100,7 @@ class Git implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle a merge action.
|
* Handle a merge action.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
|
@ -112,6 +115,7 @@ class Git implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle a tag action.
|
* Handle a tag action.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
|
@ -134,6 +138,7 @@ class Git implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle a pull action.
|
* Handle a pull action.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
|
@ -155,6 +160,7 @@ class Git implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle a push action.
|
* Handle a push action.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -73,7 +73,7 @@ class Grunt implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes grunt and runs a specified command (e.g. install / update)
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -73,7 +73,7 @@ class Gulp implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes gulp and runs a specified command (e.g. install / update)
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -31,9 +31,11 @@ class HipchatNotify implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function __construct(Builder $phpci, Build $build, array $options = array())
|
public function __construct(Builder $phpci, Build $build, array $options = array())
|
||||||
|
@ -72,8 +74,7 @@ class HipchatNotify implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the HipChat plugin.
|
* {@inheritDocs}
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -65,8 +65,7 @@ class Irc implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run IRC plugin.
|
* {@inheritDocs}
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -97,8 +96,11 @@ class Irc implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Execute a list of IRC commands.
|
||||||
|
*
|
||||||
* @param resource $socket
|
* @param resource $socket
|
||||||
* @param array $commands
|
* @param array $commands
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
private function executeIrcCommands($socket, array $commands)
|
private function executeIrcCommands($socket, array $commands)
|
||||||
|
@ -124,9 +126,11 @@ class Irc implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Execute a single IRC command.
|
||||||
*
|
*
|
||||||
* @param resource $socket
|
* @param resource $socket
|
||||||
* @param string $command
|
* @param string $command
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
private function executeIrcCommand($socket, $command)
|
private function executeIrcCommand($socket, $command)
|
||||||
|
|
|
@ -64,7 +64,7 @@ class Lint implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes parallel lint
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -86,9 +86,11 @@ class Lint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Lint an item (file or directory) by calling the appropriate method.
|
* Lint an item (file or directory) by calling the appropriate method.
|
||||||
|
*
|
||||||
* @param $php
|
* @param $php
|
||||||
* @param $item
|
* @param $item
|
||||||
* @param $itemPath
|
* @param $itemPath
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function lintItem($php, $item, $itemPath)
|
protected function lintItem($php, $item, $itemPath)
|
||||||
|
@ -106,8 +108,10 @@ class Lint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run php -l against a directory of files.
|
* Run php -l against a directory of files.
|
||||||
|
*
|
||||||
* @param $php
|
* @param $php
|
||||||
* @param $path
|
* @param $path
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function lintDirectory($php, $path)
|
protected function lintDirectory($php, $path)
|
||||||
|
@ -136,8 +140,10 @@ class Lint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run php -l against a specific file.
|
* Run php -l against a specific file.
|
||||||
|
*
|
||||||
* @param $php
|
* @param $php
|
||||||
* @param $path
|
* @param $path
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function lintFile($php, $path)
|
protected function lintFile($php, $path)
|
||||||
|
|
|
@ -95,8 +95,7 @@ class Mysql implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Connects to MySQL and runs a specified set of queries.
|
* {@inheritDocs}
|
||||||
* @return boolean
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -124,7 +123,9 @@ class Mysql implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param string $query
|
* @param string $query
|
||||||
|
*
|
||||||
* @return boolean
|
* @return boolean
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
protected function executeFile($query)
|
protected function executeFile($query)
|
||||||
|
@ -150,8 +151,10 @@ class Mysql implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Builds the MySQL import command required to import/execute the specified file
|
* Builds the MySQL import command required to import/execute the specified file
|
||||||
|
*
|
||||||
* @param string $import_file Path to file, relative to the build root
|
* @param string $import_file Path to file, relative to the build root
|
||||||
* @param string $database If specified, this database is selected before execution
|
* @param string $database If specified, this database is selected before execution
|
||||||
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function getImportCommand($import_file, $database = null)
|
protected function getImportCommand($import_file, $database = null)
|
||||||
|
|
|
@ -29,6 +29,7 @@ class PackageBuild implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -44,7 +45,7 @@ class PackageBuild implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes Composer and runs a specified command (e.g. install / update)
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -54,6 +54,7 @@ class Pdepend implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -73,7 +74,7 @@ class Pdepend implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs Pdepend with the given criteria as arguments
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -77,8 +77,7 @@ class Pgsql implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Connects to PgSQL and runs a specified set of queries.
|
* {@inheritDocs}
|
||||||
* @return boolean
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -126,6 +126,7 @@ class Phar implements PluginInterface
|
||||||
* Directory Setter
|
* Directory Setter
|
||||||
*
|
*
|
||||||
* @param string $directory Configuration Value
|
* @param string $directory Configuration Value
|
||||||
|
*
|
||||||
* @return Phar Fluent Interface
|
* @return Phar Fluent Interface
|
||||||
*/
|
*/
|
||||||
public function setDirectory($directory)
|
public function setDirectory($directory)
|
||||||
|
@ -151,6 +152,7 @@ class Phar implements PluginInterface
|
||||||
* Filename Setter
|
* Filename Setter
|
||||||
*
|
*
|
||||||
* @param string $filename Configuration Value
|
* @param string $filename Configuration Value
|
||||||
|
*
|
||||||
* @return Phar Fluent Interface
|
* @return Phar Fluent Interface
|
||||||
*/
|
*/
|
||||||
public function setFilename($filename)
|
public function setFilename($filename)
|
||||||
|
@ -176,6 +178,7 @@ class Phar implements PluginInterface
|
||||||
* Regular Expression Setter
|
* Regular Expression Setter
|
||||||
*
|
*
|
||||||
* @param string $regexp Configuration Value
|
* @param string $regexp Configuration Value
|
||||||
|
*
|
||||||
* @return Phar Fluent Interface
|
* @return Phar Fluent Interface
|
||||||
*/
|
*/
|
||||||
public function setRegExp($regexp)
|
public function setRegExp($regexp)
|
||||||
|
@ -201,6 +204,7 @@ class Phar implements PluginInterface
|
||||||
* Stub Filename Setter
|
* Stub Filename Setter
|
||||||
*
|
*
|
||||||
* @param string $stub Configuration Value
|
* @param string $stub Configuration Value
|
||||||
|
*
|
||||||
* @return Phar Fluent Interface
|
* @return Phar Fluent Interface
|
||||||
*/
|
*/
|
||||||
public function setStub($stub)
|
public function setStub($stub)
|
||||||
|
@ -221,6 +225,7 @@ class Phar implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get stub content for the Phar file.
|
* Get stub content for the Phar file.
|
||||||
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getStubContent()
|
public function getStubContent()
|
||||||
|
@ -234,8 +239,7 @@ class Phar implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the phar plugin.
|
* {@inheritDocs}
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -37,6 +37,7 @@ class Phing implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -46,9 +47,7 @@ class Phing implements PluginInterface
|
||||||
$this->setPhpci($phpci);
|
$this->setPhpci($phpci);
|
||||||
$this->build = $build;
|
$this->build = $build;
|
||||||
|
|
||||||
/*
|
// Set working directory
|
||||||
* Set working directory
|
|
||||||
*/
|
|
||||||
if (isset($options['directory'])) {
|
if (isset($options['directory'])) {
|
||||||
$directory = $phpci->buildPath . '/' . $options['directory'];
|
$directory = $phpci->buildPath . '/' . $options['directory'];
|
||||||
} else {
|
} else {
|
||||||
|
@ -57,9 +56,7 @@ class Phing implements PluginInterface
|
||||||
|
|
||||||
$this->setDirectory($directory);
|
$this->setDirectory($directory);
|
||||||
|
|
||||||
/*
|
// Set name of a non default build file
|
||||||
* Sen name of a non default build file
|
|
||||||
*/
|
|
||||||
if (isset($options['build_file'])) {
|
if (isset($options['build_file'])) {
|
||||||
$this->setBuildFile($options['build_file']);
|
$this->setBuildFile($options['build_file']);
|
||||||
}
|
}
|
||||||
|
@ -78,7 +75,7 @@ class Phing implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes Phing and runs a specified targets
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -100,7 +97,7 @@ class Phing implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return \PHPCI\Builder
|
* @return Builder
|
||||||
*/
|
*/
|
||||||
public function getPhpci()
|
public function getPhpci()
|
||||||
{
|
{
|
||||||
|
@ -108,7 +105,7 @@ class Phing implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \PHPCI\Builder $phpci
|
* @param Builder $phpci
|
||||||
*
|
*
|
||||||
* @return $this
|
* @return $this
|
||||||
*/
|
*/
|
||||||
|
@ -145,6 +142,7 @@ class Phing implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Converts an array of targets into a string.
|
* Converts an array of targets into a string.
|
||||||
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
private function targetsToString()
|
private function targetsToString()
|
||||||
|
@ -178,6 +176,7 @@ class Phing implements PluginInterface
|
||||||
* @param mixed $buildFile
|
* @param mixed $buildFile
|
||||||
*
|
*
|
||||||
* @return $this
|
* @return $this
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function setBuildFile($buildFile)
|
public function setBuildFile($buildFile)
|
||||||
|
@ -191,6 +190,7 @@ class Phing implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get phing build file path.
|
* Get phing build file path.
|
||||||
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getBuildFilePath()
|
public function getBuildFilePath()
|
||||||
|
@ -211,10 +211,8 @@ class Phing implements PluginInterface
|
||||||
*/
|
*/
|
||||||
public function propertiesToString()
|
public function propertiesToString()
|
||||||
{
|
{
|
||||||
/**
|
// Fix the problem when execute phing out of the build dir
|
||||||
* fix the problem when execute phing out of the build dir
|
// @ticket 748
|
||||||
* @ticket 748
|
|
||||||
*/
|
|
||||||
if (!isset($this->properties['project.basedir'])) {
|
if (!isset($this->properties['project.basedir'])) {
|
||||||
$this->properties['project.basedir'] = $this->getDirectory();
|
$this->properties['project.basedir'] = $this->getDirectory();
|
||||||
}
|
}
|
||||||
|
@ -254,6 +252,7 @@ class Phing implements PluginInterface
|
||||||
* @param string $propertyFile
|
* @param string $propertyFile
|
||||||
*
|
*
|
||||||
* @return $this
|
* @return $this
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function setPropertyFile($propertyFile)
|
public function setPropertyFile($propertyFile)
|
||||||
|
|
|
@ -78,11 +78,7 @@ class PhpCodeSniffer implements PluginInterface, PluginZeroConfigInterface
|
||||||
protected $ignore;
|
protected $ignore;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if this plugin can be executed.
|
* {@inheritDocs}
|
||||||
* @param $stage
|
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -134,6 +130,7 @@ class PhpCodeSniffer implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle this plugin's options.
|
* Handle this plugin's options.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
*/
|
*/
|
||||||
protected function setOptions($options)
|
protected function setOptions($options)
|
||||||
|
@ -146,7 +143,7 @@ class PhpCodeSniffer implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs PHP Code Sniffer in a specified directory, to a specified standard.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -190,6 +187,7 @@ class PhpCodeSniffer implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Process options and produce an arguments string for PHPCS.
|
* Process options and produce an arguments string for PHPCS.
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected function getFlags()
|
protected function getFlags()
|
||||||
|
@ -215,8 +213,11 @@ class PhpCodeSniffer implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Process the PHPCS output report.
|
* Process the PHPCS output report.
|
||||||
|
*
|
||||||
* @param $output
|
* @param $output
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
protected function processReport($output)
|
protected function processReport($output)
|
||||||
|
|
|
@ -43,6 +43,7 @@ class PhpCpd implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -70,7 +71,7 @@ class PhpCpd implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs PHP Copy/Paste Detector in a specified directory.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -112,8 +113,11 @@ class PhpCpd implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Process the PHPCPD XML report.
|
* Process the PHPCPD XML report.
|
||||||
|
*
|
||||||
* @param $xmlString
|
* @param $xmlString
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
protected function processReport($xmlString)
|
protected function processReport($xmlString)
|
||||||
|
|
|
@ -63,8 +63,7 @@ class PhpCsFixer implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run PHP CS Fixer.
|
* {@inheritDocs}
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -83,6 +82,7 @@ class PhpCsFixer implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build an args string for PHPCS Fixer.
|
* Build an args string for PHPCS Fixer.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
*/
|
*/
|
||||||
public function buildArgs($options)
|
public function buildArgs($options)
|
||||||
|
@ -102,6 +102,5 @@ class PhpCsFixer implements PluginInterface
|
||||||
if (isset($options['workingdir']) && $options['workingdir']) {
|
if (isset($options['workingdir']) && $options['workingdir']) {
|
||||||
$this->workingdir = $this->phpci->buildPath . $options['workingdir'];
|
$this->workingdir = $this->phpci->buildPath . $options['workingdir'];
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -51,11 +51,7 @@ class PhpDocblockChecker implements PluginInterface, PluginZeroConfigInterface
|
||||||
protected $skipMethods = false;
|
protected $skipMethods = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if this plugin can be executed.
|
* {@inheritDocs}
|
||||||
* @param $stage
|
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -68,6 +64,7 @@ class PhpDocblockChecker implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -102,7 +99,7 @@ class PhpDocblockChecker implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs PHP Mess Detector in a specified directory.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -160,6 +157,7 @@ class PhpDocblockChecker implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Report all of the errors we've encountered line-by-line.
|
* Report all of the errors we've encountered line-by-line.
|
||||||
|
*
|
||||||
* @param $output
|
* @param $output
|
||||||
*/
|
*/
|
||||||
protected function reportErrors($output)
|
protected function reportErrors($output)
|
||||||
|
|
|
@ -28,17 +28,14 @@ class PhpLoc implements PluginInterface, PluginZeroConfigInterface
|
||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
protected $directory;
|
protected $directory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \PHPCI\Builder
|
* @var \PHPCI\Builder
|
||||||
*/
|
*/
|
||||||
protected $phpci;
|
protected $phpci;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if this plugin can be executed.
|
* {@inheritDocs}
|
||||||
* @param $stage
|
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -51,6 +48,7 @@ class PhpLoc implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -67,7 +65,7 @@ class PhpLoc implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs PHP Copy/Paste Detector in a specified directory.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -59,11 +59,7 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
protected $rules;
|
protected $rules;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if this plugin can be executed.
|
* {@inheritDocs}
|
||||||
* @param $stage
|
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -114,7 +110,7 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs PHP Mess Detector in a specified directory.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -135,6 +131,7 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Override a default setting.
|
* Override a default setting.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
* @param $key
|
* @param $key
|
||||||
*/
|
*/
|
||||||
|
@ -147,8 +144,11 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Process PHPMD's XML output report.
|
* Process PHPMD's XML output report.
|
||||||
|
*
|
||||||
* @param $xmlString
|
* @param $xmlString
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
protected function processReport($xmlString)
|
protected function processReport($xmlString)
|
||||||
|
@ -189,6 +189,7 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Try and process the rules parameter from phpci.yml.
|
* Try and process the rules parameter from phpci.yml.
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function tryAndProcessRules()
|
protected function tryAndProcessRules()
|
||||||
|
@ -209,6 +210,7 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute PHP Mess Detector.
|
* Execute PHP Mess Detector.
|
||||||
|
*
|
||||||
* @param $binaryPath
|
* @param $binaryPath
|
||||||
*/
|
*/
|
||||||
protected function executePhpMd($binaryPath)
|
protected function executePhpMd($binaryPath)
|
||||||
|
@ -245,6 +247,7 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the path PHPMD should be run against.
|
* Get the path PHPMD should be run against.
|
||||||
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function getTargetPath()
|
protected function getTargetPath()
|
||||||
|
@ -261,6 +264,7 @@ class PhpMessDetector implements PluginInterface, PluginZeroConfigInterface
|
||||||
* Returns a boolean indicating if the error count can be considered a success.
|
* Returns a boolean indicating if the error count can be considered a success.
|
||||||
*
|
*
|
||||||
* @param int $errorCount
|
* @param int $errorCount
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function wasLastExecSuccessful($errorCount)
|
protected function wasLastExecSuccessful($errorCount)
|
||||||
|
|
|
@ -72,7 +72,7 @@ class PhpParallelLint implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes parallel lint
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -99,6 +99,7 @@ class PhpParallelLint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Produce an argument string for PHP Parallel Lint.
|
* Produce an argument string for PHP Parallel Lint.
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected function getFlags()
|
protected function getFlags()
|
||||||
|
|
|
@ -24,12 +24,12 @@ use PHPCI\PluginInterface;
|
||||||
class PhpSpec implements PluginInterface
|
class PhpSpec implements PluginInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var \PHPCI\Builder
|
* @var Builder
|
||||||
*/
|
*/
|
||||||
protected $phpci;
|
protected $phpci;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \PHPCI\Model\Build
|
* @var Build
|
||||||
*/
|
*/
|
||||||
protected $build;
|
protected $build;
|
||||||
|
|
||||||
|
@ -40,6 +40,7 @@ class PhpSpec implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -52,7 +53,7 @@ class PhpSpec implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs PHP Spec tests.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -145,7 +146,6 @@ class PhpSpec implements PluginInterface
|
||||||
|
|
||||||
$this->build->storeMeta('phpspec', $data);
|
$this->build->storeMeta('phpspec', $data);
|
||||||
|
|
||||||
|
|
||||||
return $success;
|
return $success;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -29,12 +29,12 @@ class PhpTalLint implements PluginInterface
|
||||||
protected $ignore;
|
protected $ignore;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \PHPCI\Builder
|
* @var Builder
|
||||||
*/
|
*/
|
||||||
protected $phpci;
|
protected $phpci;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \PHPCI\Model\Build
|
* @var Build
|
||||||
*/
|
*/
|
||||||
protected $build;
|
protected $build;
|
||||||
|
|
||||||
|
@ -89,6 +89,7 @@ class PhpTalLint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle this plugin's options.
|
* Handle this plugin's options.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
*/
|
*/
|
||||||
protected function setOptions($options)
|
protected function setOptions($options)
|
||||||
|
@ -101,7 +102,7 @@ class PhpTalLint implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes phptal lint
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -145,8 +146,10 @@ class PhpTalLint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Lint an item (file or directory) by calling the appropriate method.
|
* Lint an item (file or directory) by calling the appropriate method.
|
||||||
|
*
|
||||||
* @param $item
|
* @param $item
|
||||||
* @param $itemPath
|
* @param $itemPath
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function lintItem($item, $itemPath)
|
protected function lintItem($item, $itemPath)
|
||||||
|
@ -166,7 +169,9 @@ class PhpTalLint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run phptal lint against a directory of files.
|
* Run phptal lint against a directory of files.
|
||||||
|
*
|
||||||
* @param $path
|
* @param $path
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function lintDirectory($path)
|
protected function lintDirectory($path)
|
||||||
|
@ -195,7 +200,9 @@ class PhpTalLint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run phptal lint against a specific file.
|
* Run phptal lint against a specific file.
|
||||||
|
*
|
||||||
* @param $path
|
* @param $path
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
protected function lintFile($path)
|
protected function lintFile($path)
|
||||||
|
@ -246,6 +253,7 @@ class PhpTalLint implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Process options and produce an arguments string for PHPTAL Lint.
|
* Process options and produce an arguments string for PHPTAL Lint.
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected function getFlags()
|
protected function getFlags()
|
||||||
|
|
|
@ -53,11 +53,7 @@ class PhpUnit implements PluginInterface, PluginZeroConfigInterface
|
||||||
protected $xmlConfigFile;
|
protected $xmlConfigFile;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if this plugin can be executed.
|
* {@inheritDocs}
|
||||||
* @param $stage
|
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -70,7 +66,9 @@ class PhpUnit implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Try and find the phpunit XML config file.
|
* Try and find the phpunit XML config file.
|
||||||
|
*
|
||||||
* @param $buildPath
|
* @param $buildPath
|
||||||
|
*
|
||||||
* @return null|string
|
* @return null|string
|
||||||
*/
|
*/
|
||||||
public static function findConfigFile($buildPath)
|
public static function findConfigFile($buildPath)
|
||||||
|
@ -141,7 +139,7 @@ class PhpUnit implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs PHP Unit tests in a specified directory, optionally using specified config file(s).
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -187,7 +185,9 @@ class PhpUnit implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the tests defined in a PHPUnit config file.
|
* Run the tests defined in a PHPUnit config file.
|
||||||
|
*
|
||||||
* @param $configPath
|
* @param $configPath
|
||||||
|
*
|
||||||
* @return bool|mixed
|
* @return bool|mixed
|
||||||
*/
|
*/
|
||||||
protected function runConfigFile($configPath)
|
protected function runConfigFile($configPath)
|
||||||
|
@ -215,7 +215,9 @@ class PhpUnit implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the PHPUnit tests in a specific directory or array of directories.
|
* Run the PHPUnit tests in a specific directory or array of directories.
|
||||||
|
*
|
||||||
* @param $directory
|
* @param $directory
|
||||||
|
*
|
||||||
* @return bool|mixed
|
* @return bool|mixed
|
||||||
*/
|
*/
|
||||||
protected function runDir($directory)
|
protected function runDir($directory)
|
||||||
|
@ -238,6 +240,7 @@ class PhpUnit implements PluginInterface, PluginZeroConfigInterface
|
||||||
/**
|
/**
|
||||||
* @param $array
|
* @param $array
|
||||||
* @param $callable
|
* @param $callable
|
||||||
|
*
|
||||||
* @return bool|mixed
|
* @return bool|mixed
|
||||||
*/
|
*/
|
||||||
protected function recurseArg($array, $callable)
|
protected function recurseArg($array, $callable)
|
||||||
|
|
|
@ -77,7 +77,7 @@ class Shell implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs the shell command.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -72,8 +72,7 @@ class SlackNotify implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the Slack plugin.
|
* {@inheritDocs}
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -62,8 +62,7 @@ class Sqlite implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Connects to SQLite and runs a specified set of queries.
|
* {@inheritDocs}
|
||||||
* @return boolean
|
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -67,12 +67,7 @@ class TechnicalDebt implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if this plugin can be executed.
|
* {@inheritDocs}
|
||||||
*
|
|
||||||
* @param $stage
|
|
||||||
* @param Builder $builder
|
|
||||||
* @param Build $build
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function canExecute($stage, Builder $builder, Build $build)
|
public static function canExecute($stage, Builder $builder, Build $build)
|
||||||
{
|
{
|
||||||
|
@ -112,6 +107,7 @@ class TechnicalDebt implements PluginInterface, PluginZeroConfigInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle this plugin's options.
|
* Handle this plugin's options.
|
||||||
|
*
|
||||||
* @param $options
|
* @param $options
|
||||||
*/
|
*/
|
||||||
protected function setOptions($options)
|
protected function setOptions($options)
|
||||||
|
@ -124,7 +120,7 @@ class TechnicalDebt implements PluginInterface, PluginZeroConfigInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs the plugin
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -36,6 +36,7 @@ class Wipe implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up the plugin, configure options, etc.
|
* Set up the plugin, configure options, etc.
|
||||||
|
*
|
||||||
* @param Builder $phpci
|
* @param Builder $phpci
|
||||||
* @param Build $build
|
* @param Build $build
|
||||||
* @param array $options
|
* @param array $options
|
||||||
|
@ -49,7 +50,7 @@ class Wipe implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wipes a directory's contents
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
|
|
@ -131,6 +131,8 @@ class XMPP implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Find config file for sendxmpp binary (default is .sendxmpprc)
|
* Find config file for sendxmpp binary (default is .sendxmpprc)
|
||||||
|
*
|
||||||
|
* @return bool|null
|
||||||
*/
|
*/
|
||||||
public function findConfigFile()
|
public function findConfigFile()
|
||||||
{
|
{
|
||||||
|
@ -146,7 +148,7 @@ class XMPP implements PluginInterface
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Send notification message.
|
* {@inheritDocs}
|
||||||
*/
|
*/
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
|
@ -201,6 +203,7 @@ class XMPP implements PluginInterface
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param $message_file
|
* @param $message_file
|
||||||
|
*
|
||||||
* @return int
|
* @return int
|
||||||
*/
|
*/
|
||||||
protected function buildMessage($message_file)
|
protected function buildMessage($message_file)
|
||||||
|
|
|
@ -19,7 +19,7 @@ use PHPCI\Model\Build;
|
||||||
interface PluginZeroConfigInterface
|
interface PluginZeroConfigInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Execute the plugin withput requiring configuration.
|
* Check if this plugin can be executed.
|
||||||
*
|
*
|
||||||
* @param string $stage The current stage
|
* @param string $stage The current stage
|
||||||
* @param Builder $builder The plugin builder
|
* @param Builder $builder The plugin builder
|
||||||
|
|
Loading…
Reference in a new issue