diff --git a/PHPCI/Command/GenerateCommand.php b/PHPCI/Command/GenerateCommand.php index d9f74caf..c77708f6 100644 --- a/PHPCI/Command/GenerateCommand.php +++ b/PHPCI/Command/GenerateCommand.php @@ -15,6 +15,12 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** +* Generate console command - Reads the database and generates models and stores. +* @author Dan Cryer +* @package PHPCI +* @subpackage Console +*/ class GenerateCommand extends Command { protected function configure() diff --git a/PHPCI/Command/InstallCommand.php b/PHPCI/Command/InstallCommand.php index 22dfc6e9..f299240b 100644 --- a/PHPCI/Command/InstallCommand.php +++ b/PHPCI/Command/InstallCommand.php @@ -17,6 +17,12 @@ use Symfony\Component\Console\Output\OutputInterface; use b8\Store\Factory; use PHPCI\Builder; +/** +* Install console command - Installs PHPCI. +* @author Dan Cryer +* @package PHPCI +* @subpackage Console +*/ class InstallCommand extends Command { protected function configure() diff --git a/PHPCI/Command/RunCommand.php b/PHPCI/Command/RunCommand.php index 2865899b..7f62521d 100644 --- a/PHPCI/Command/RunCommand.php +++ b/PHPCI/Command/RunCommand.php @@ -18,6 +18,12 @@ use b8\Store\Factory; use PHPCI\Builder, PHPCI\BuildFactory; +/** +* Run console command - Runs any pending builds. +* @author Dan Cryer +* @package PHPCI +* @subpackage Console +*/ class RunCommand extends Command { protected function configure() diff --git a/PHPCI/Controller/BitbucketController.php b/PHPCI/Controller/BitbucketController.php index e938d8f9..3aee057a 100644 --- a/PHPCI/Controller/BitbucketController.php +++ b/PHPCI/Controller/BitbucketController.php @@ -12,7 +12,12 @@ use b8, b8\Store, PHPCI\Model\Build; - +/** +* BitBucket Controller - Processes webhook pings from BitBucket. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class BitbucketController extends b8\Controller { public function init() diff --git a/PHPCI/Controller/BuildController.php b/PHPCI/Controller/BuildController.php index 544f37a4..225a75af 100644 --- a/PHPCI/Controller/BuildController.php +++ b/PHPCI/Controller/BuildController.php @@ -12,6 +12,12 @@ use b8, b8\Registry, PHPCI\Model\Build; +/** +* Build Controller - Allows users to run and view builds. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class BuildController extends b8\Controller { public function init() diff --git a/PHPCI/Controller/GithubController.php b/PHPCI/Controller/GithubController.php index 9cbe992e..8d18cd35 100644 --- a/PHPCI/Controller/GithubController.php +++ b/PHPCI/Controller/GithubController.php @@ -12,7 +12,12 @@ use b8, b8\Store, PHPCI\Model\Build; - +/** +* Github Controller - Processes webhook pings from Github. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class GithubController extends b8\Controller { public function init() diff --git a/PHPCI/Controller/IndexController.php b/PHPCI/Controller/IndexController.php index dc0cfee3..eed3273b 100644 --- a/PHPCI/Controller/IndexController.php +++ b/PHPCI/Controller/IndexController.php @@ -10,6 +10,12 @@ namespace PHPCI\Controller; use b8; +/** +* Index Controller - Displays the PHPCI Dashboard. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class IndexController extends b8\Controller { public function init() diff --git a/PHPCI/Controller/ProjectController.php b/PHPCI/Controller/ProjectController.php index d140c272..ed177e38 100644 --- a/PHPCI/Controller/ProjectController.php +++ b/PHPCI/Controller/ProjectController.php @@ -14,6 +14,12 @@ use b8, b8\Form, b8\Registry; +/** +* Project Controller - Allows users to create, edit and view projects. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class ProjectController extends b8\Controller { public function init() diff --git a/PHPCI/Controller/SessionController.php b/PHPCI/Controller/SessionController.php index ce2158a4..4538e1f7 100644 --- a/PHPCI/Controller/SessionController.php +++ b/PHPCI/Controller/SessionController.php @@ -10,6 +10,12 @@ namespace PHPCI\Controller; use b8; +/** +* Session Controller - Handles user login / logout. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class SessionController extends b8\Controller { public function init() diff --git a/PHPCI/Controller/UserController.php b/PHPCI/Controller/UserController.php index 31391a6e..3037682f 100644 --- a/PHPCI/Controller/UserController.php +++ b/PHPCI/Controller/UserController.php @@ -13,6 +13,12 @@ use b8, PHPCI\Model\User, b8\Form; +/** +* User Controller - Allows an administrator to view, add, edit and delete users. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class UserController extends b8\Controller { public function init() diff --git a/PHPCI/Helper/User.php b/PHPCI/Helper/User.php index e5a8519c..aea39fbe 100644 --- a/PHPCI/Helper/User.php +++ b/PHPCI/Helper/User.php @@ -9,6 +9,12 @@ namespace PHPCI\Helper; +/** +* User Helper - Provides access to logged in user information in views. +* @author Dan Cryer +* @package PHPCI +* @subpackage Web +*/ class User { public function __call($method, $params = array()) diff --git a/PHPCI/Model/Build.php b/PHPCI/Model/Build.php index 1561c20c..bd6677ad 100644 --- a/PHPCI/Model/Build.php +++ b/PHPCI/Model/Build.php @@ -15,9 +15,12 @@ use PHPCI\Model\Base\BuildBase, PHPCI\Builder; /** - * Build Model - * @uses PHPCI\Model\Base\BuildBase - */ +* Build Model +* @uses PHPCI\Model\Base\BuildBase +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ class Build extends BuildBase { public function getCommitLink() diff --git a/PHPCI/Model/Build/BitbucketBuild.php b/PHPCI/Model/Build/BitbucketBuild.php index f7cbbbed..9631788d 100644 --- a/PHPCI/Model/Build/BitbucketBuild.php +++ b/PHPCI/Model/Build/BitbucketBuild.php @@ -8,13 +8,15 @@ */ namespace PHPCI\Model\Build; -use PHPCI\Model\Build; -use PHPCI\Model\Build\RemoteGitBuild; +use PHPCI\Model\Build, + PHPCI\Model\Build\RemoteGitBuild; /** - * BitBucket Build Model - * @uses PHPCI\Model\Build - */ +* BitBucket Build Model +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ class BitbucketBuild extends RemoteGitBuild { public function getCommitLink() diff --git a/PHPCI/Model/Build/GithubBuild.php b/PHPCI/Model/Build/GithubBuild.php index 9d2aa850..283823e1 100644 --- a/PHPCI/Model/Build/GithubBuild.php +++ b/PHPCI/Model/Build/GithubBuild.php @@ -11,9 +11,11 @@ namespace PHPCI\Model\Build; use PHPCI\Model\Build\RemoteGitBuild; /** - * Github Build Model - * @uses PHPCI\Model\Build - */ +* Github Build Model +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ class GithubBuild extends RemoteGitBuild { public function getCommitLink() diff --git a/PHPCI/Model/Build/LocalBuild.php b/PHPCI/Model/Build/LocalBuild.php index 0bdce84e..9a4374be 100644 --- a/PHPCI/Model/Build/LocalBuild.php +++ b/PHPCI/Model/Build/LocalBuild.php @@ -8,14 +8,16 @@ */ namespace PHPCI\Model\Build; -use PHPCI\Model\Build; -use Symfony\Component\Yaml\Parser as YamlParser; -use PHPCI\Builder; +use PHPCI\Model\Build, + PHPCI\Builder, + Symfony\Component\Yaml\Parser as YamlParser; /** - * Local Build Model - * @uses PHPCI\Model\Build - */ +* Local Build Model +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ class LocalBuild extends Build { public function createWorkingCopy(Builder $builder, $buildPath) diff --git a/PHPCI/Model/Build/RemoteGitBuild.php b/PHPCI/Model/Build/RemoteGitBuild.php index ef95b14f..8f10c713 100644 --- a/PHPCI/Model/Build/RemoteGitBuild.php +++ b/PHPCI/Model/Build/RemoteGitBuild.php @@ -8,14 +8,16 @@ */ namespace PHPCI\Model\Build; -use PHPCI\Model\Build; -use PHPCI\Builder; -use Symfony\Component\Yaml\Parser as YamlParser; +use PHPCI\Model\Build, + PHPCI\Builder, + Symfony\Component\Yaml\Parser as YamlParser; /** - * Remote Build Model - * @uses PHPCI\Model\Build - */ +* Remote Git Build Model +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ abstract class RemoteGitBuild extends Build { abstract protected function getCloneUrl(); diff --git a/PHPCI/Model/Project.php b/PHPCI/Model/Project.php index 9c3f2b49..df25bd58 100644 --- a/PHPCI/Model/Project.php +++ b/PHPCI/Model/Project.php @@ -14,9 +14,12 @@ require_once(APPLICATION_PATH . 'PHPCI/Model/Base/ProjectBase.php'); use PHPCI\Model\Base\ProjectBase; /** - * Project Model - * @uses PHPCI\Model\Base\ProjectBase - */ +* Project Model +* @uses PHPCI\Model\Base\ProjectBase +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ class Project extends ProjectBase { } diff --git a/PHPCI/Model/User.php b/PHPCI/Model/User.php index 56b51014..fc3ae741 100644 --- a/PHPCI/Model/User.php +++ b/PHPCI/Model/User.php @@ -14,9 +14,12 @@ require_once(APPLICATION_PATH . 'PHPCI/Model/Base/UserBase.php'); use PHPCI\Model\Base\UserBase; /** - * User Model - * @uses PHPCI\Model\Base\UserBase - */ +* User Model +* @uses PHPCI\Model\Base\UserBase +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ class User extends UserBase { // This class has been left blank so that you can modify it - changes in this file will not be overwritten. diff --git a/PHPCI/Plugin/Composer.php b/PHPCI/Plugin/Composer.php index c5bfeceb..469dd9da 100644 --- a/PHPCI/Plugin/Composer.php +++ b/PHPCI/Plugin/Composer.php @@ -9,6 +9,12 @@ namespace PHPCI\Plugin; +/** +* Composer Plugin - Provides access to Composer functionality. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class Composer implements \PHPCI\Plugin { protected $directory; diff --git a/PHPCI/Plugin/Mysql.php b/PHPCI/Plugin/Mysql.php index 73eab0b7..84898020 100644 --- a/PHPCI/Plugin/Mysql.php +++ b/PHPCI/Plugin/Mysql.php @@ -10,6 +10,12 @@ namespace PHPCI\Plugin; use PDO; +/** +* MySQL Plugin - Provides access to a MySQL database. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class Mysql implements \PHPCI\Plugin { protected $phpci; diff --git a/PHPCI/Plugin/Pgsql.php b/PHPCI/Plugin/Pgsql.php index a71089c5..9870eec6 100644 --- a/PHPCI/Plugin/Pgsql.php +++ b/PHPCI/Plugin/Pgsql.php @@ -10,6 +10,12 @@ namespace PHPCI\Plugin; use PDO; +/** +* PgSQL Plugin - Provides access to a PgSQL database. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class Pgsql implements \PHPCI\Plugin { protected $phpci; diff --git a/PHPCI/Plugin/PhpCodeSniffer.php b/PHPCI/Plugin/PhpCodeSniffer.php index 103236a9..276bbe68 100644 --- a/PHPCI/Plugin/PhpCodeSniffer.php +++ b/PHPCI/Plugin/PhpCodeSniffer.php @@ -9,6 +9,12 @@ namespace PHPCI\Plugin; +/** +* PHP Code Sniffer Plugin - Allows PHP Code Sniffer testing. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class PhpCodeSniffer implements \PHPCI\Plugin { protected $directory; diff --git a/PHPCI/Plugin/PhpCpd.php b/PHPCI/Plugin/PhpCpd.php index b6affb63..94aebca0 100644 --- a/PHPCI/Plugin/PhpCpd.php +++ b/PHPCI/Plugin/PhpCpd.php @@ -9,6 +9,12 @@ namespace PHPCI\Plugin; +/** +* PHP Copy / Paste Detector - Allows PHP Copy / Paste Detector testing. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class PhpCpd implements \PHPCI\Plugin { protected $directory; diff --git a/PHPCI/Plugin/PhpMessDetector.php b/PHPCI/Plugin/PhpMessDetector.php index 7a02c1da..00cce6e3 100644 --- a/PHPCI/Plugin/PhpMessDetector.php +++ b/PHPCI/Plugin/PhpMessDetector.php @@ -9,6 +9,12 @@ namespace PHPCI\Plugin; +/** +* PHP Mess Detector Plugin - Allows PHP Mess Detector testing. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class PhpMessDetector implements \PHPCI\Plugin { protected $directory; diff --git a/PHPCI/Plugin/PhpSpec.php b/PHPCI/Plugin/PhpSpec.php index 8cb461d9..06e9201f 100644 --- a/PHPCI/Plugin/PhpSpec.php +++ b/PHPCI/Plugin/PhpSpec.php @@ -9,6 +9,12 @@ namespace PHPCI\Plugin; +/** +* PHP Spec Plugin - Allows PHP Spec testing. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class PhpSpec implements \PHPCI\Plugin { protected $phpci; diff --git a/PHPCI/Plugin/PhpUnit.php b/PHPCI/Plugin/PhpUnit.php index 43248129..be631abb 100644 --- a/PHPCI/Plugin/PhpUnit.php +++ b/PHPCI/Plugin/PhpUnit.php @@ -9,6 +9,12 @@ namespace PHPCI\Plugin; +/** +* PHP Unit Plugin - Allows PHP Unit testing. +* @author Dan Cryer +* @package PHPCI +* @subpackage Plugins +*/ class PhpUnit implements \PHPCI\Plugin { protected $args; diff --git a/PHPCI/Store/ProjectStore.php b/PHPCI/Store/ProjectStore.php index 4b1d1879..b36e9b0e 100644 --- a/PHPCI/Store/ProjectStore.php +++ b/PHPCI/Store/ProjectStore.php @@ -14,9 +14,11 @@ require_once(APPLICATION_PATH . 'PHPCI/Store/Base/ProjectStoreBase.php'); use PHPCI\Store\Base\ProjectStoreBase; /** - * Project Store - * @uses PHPCI\Store\Base\ProjectStoreBase - */ +* Project Store +* @author Dan Cryer +* @package PHPCI +* @subpackage Core +*/ class ProjectStore extends ProjectStoreBase { // This class has been left blank so that you can modify it - changes in this file will not be overwritten. diff --git a/PHPCI/Store/UserStore.php b/PHPCI/Store/UserStore.php index 5d44ae92..f6ddb23f 100644 --- a/PHPCI/Store/UserStore.php +++ b/PHPCI/Store/UserStore.php @@ -1,8 +1,11 @@ +* @package PHPCI +* @subpackage Core +*/ class UserStore extends UserStoreBase { // This class has been left blank so that you can modify it - changes in this file will not be overwritten.