From f2f3d56e369762bc79dc9f45570bc0362fc09862 Mon Sep 17 00:00:00 2001 From: pies Date: Sun, 5 Jun 2005 23:41:46 +0000 Subject: [PATCH] Added back the @package and @subpackage headers to /app and /config files. git-svn-id: https://svn.cakephp.org/repo/trunk/cake@239 3807eeeb-6ff5-0310-8944-8be069107fe0 --- app/app_controller.php | 5 +++- app/app_model.php | 5 +++- app/controllers/pages_controller.php | 3 +++ app/controllers/tests_controller.php | 28 +++++++++++-------- app/helpers/pages_helper.php | 10 ++++++- app/helpers/tests_helper.php | 10 ++++++- config/core.php | 3 +++ config/database.php.default | 3 +++ config/paths.php | 40 +++++++++++++++++----------- config/routes.php | 3 +++ config/routes.php.default | 3 +++ config/tags.php | 3 +++ 12 files changed, 86 insertions(+), 30 deletions(-) diff --git a/app/app_controller.php b/app/app_controller.php index 8c68b7dd4..2b0da0a2a 100644 --- a/app/app_controller.php +++ b/app/app_controller.php @@ -13,7 +13,10 @@ * application-wide controller-related methods here. * * Add your application-wide methods in the class below, your controllers - * will be inheriting them. + * will inherit them. + * + * @package cake + * @subpackage cake.app */ class AppController extends Controller { diff --git a/app/app_model.php b/app/app_model.php index d4d42069a..1fab0c903 100644 --- a/app/app_model.php +++ b/app/app_model.php @@ -13,7 +13,10 @@ * application-wide model-related methods here. * * Add your application-wide methods in the class below, your models - * will be inheriting them. + * will inherit them. + * + * @package cake + * @subpackage cake.app */ class AppModel extends Model { diff --git a/app/controllers/pages_controller.php b/app/controllers/pages_controller.php index cb3682220..58cd38deb 100644 --- a/app/controllers/pages_controller.php +++ b/app/controllers/pages_controller.php @@ -12,6 +12,9 @@ class PagesController extends PagesHelper { /** * Displays a view + * + * @package cake + * @subpackage cake.app */ function display () { diff --git a/app/controllers/tests_controller.php b/app/controllers/tests_controller.php index d9d56b739..bff182cd1 100644 --- a/app/controllers/tests_controller.php +++ b/app/controllers/tests_controller.php @@ -10,32 +10,38 @@ /** - * Description: - * + * The includes below are required for the TestsController to work. */ uses('test', 'folder', 'inflector'); class TestsController extends TestsHelper { /** - * Runs all library and application tests + * Runs all library and application tests + * + * @package cake + * @subpackage cake.app */ - function test_all () { - + function test_all () + { $this->layout = 'test'; $tests_folder = new Folder('../tests'); $results = array(); $total_errors = 0; - foreach ($tests_folder->findRecursive('.*\.php') as $test) { - if (preg_match('/^(.+)\.php/i', basename($test), $r)) { + foreach ($tests_folder->findRecursive('.*\.php') as $test) + { + if (preg_match('/^(.+)\.php/i', basename($test), $r)) + { require_once($test); $test_name = Inflector::Camelize($r[1]); - if (preg_match('/^(.+)Test$/i', $test_name, $r)) { + if (preg_match('/^(.+)Test$/i', $test_name, $r)) + { $module_name = $r[1]; } - else { + else + { $module_name = $test_name; } $suite = new TestSuite($test_name); @@ -43,7 +49,8 @@ class TestsController extends TestsHelper { $total_errors += $result['errors']; - $results[] = array( + $results[] = array + ( 'name'=>$module_name, 'result'=>$result, ); @@ -53,7 +60,6 @@ class TestsController extends TestsHelper { $this->set('success', !$total_errors); $this->set('results', $results); } - } ?> diff --git a/app/helpers/pages_helper.php b/app/helpers/pages_helper.php index 48de6ed25..305e0850b 100644 --- a/app/helpers/pages_helper.php +++ b/app/helpers/pages_helper.php @@ -8,7 +8,15 @@ // + Licensed under The MIT License + // ////////////////////////////////////////////////////////////////////////// -class PagesHelper extends AppController { +/** + * In this file you can extend the PagesController. + * + * @package cake + * @subpackage cake.app + */ + +class PagesHelper extends AppController +{ } ?> \ No newline at end of file diff --git a/app/helpers/tests_helper.php b/app/helpers/tests_helper.php index 00fb4d095..1c07e60d2 100644 --- a/app/helpers/tests_helper.php +++ b/app/helpers/tests_helper.php @@ -8,7 +8,15 @@ // + Licensed under The MIT License + // ////////////////////////////////////////////////////////////////////////// -class TestsHelper extends AppController { +/** + * In this file you can extend the TestsController. + * + * @package cake + * @subpackage cake.app + */ + +class TestsHelper extends AppController +{ } ?> \ No newline at end of file diff --git a/config/core.php b/config/core.php index 38e908d04..aa791b8a7 100644 --- a/config/core.php +++ b/config/core.php @@ -11,6 +11,9 @@ /** * This is core configuration file. Use it to configure core behaviour of * Cake. + * + * @package cake + * @subpackage cake.config */ /** diff --git a/config/database.php.default b/config/database.php.default index b8a9f809d..0bb0139b0 100644 --- a/config/database.php.default +++ b/config/database.php.default @@ -10,6 +10,9 @@ /** * In this file you set up your database connection details. + * + * @package cake + * @subpackage cake.config */ /** diff --git a/config/paths.php b/config/paths.php index dea82c4b8..800499bc6 100644 --- a/config/paths.php +++ b/config/paths.php @@ -10,6 +10,9 @@ /** * In this file you set paths to different directories used by Cake. + * + * @package cake + * @subpackage cake.config */ /** @@ -45,19 +48,19 @@ define ('HELPERS', APP.'helpers'.DS); /** * Path to the application's views directory. */ -define ('VIEWS', APP.'views'.DS); +define ('VIEWS', APP.'views'.DS); /** * Path to the application's view's layouts directory. */ -define ('LAYOUTS', APP.'views'.DS.'layouts'.DS); +define ('LAYOUTS', APP.'views'.DS.'layouts'.DS); /** * Path to the application's view's elements directory. * It's supposed to hold pieces of PHP/HTML that are used on multiple pages * and are not linked to a particular layout (like polls, footers and so on). */ -define ('ELEMENTS', APP.'views'.DS.'elements'.DS); +define ('ELEMENTS', APP.'views'.DS.'elements'.DS); /** * Path to the configuration files directory. @@ -67,12 +70,12 @@ define ('CONFIGS', ROOT.'config'.DS); /** * Path to the libs directory. */ -define ('LIBS', ROOT.'libs'.DS); +define ('LIBS', ROOT.'libs'.DS); /** * Path to the logs directory. */ -define ('LOGS', ROOT.'logs'.DS); +define ('LOGS', ROOT.'logs'.DS); /** * Path to the modules directory. @@ -82,17 +85,12 @@ define ('MODULES', ROOT.'modules'.DS); /** * Path to the public directory. */ -define ('PUBLIC', ROOT.'public'.DS); +define ('PUBLIC', ROOT.'public'.DS); /** * Path to the tests directory. */ -define ('TESTS', ROOT.'tests'.DS); - -/** - * Path to the vendors directory. - */ -define ('VENDORS', ROOT.'vendors'.DS); +define ('TESTS', ROOT.'tests'.DS); /** * Path to the controller test directory. @@ -102,16 +100,28 @@ define ('CONTROLLER_TESTS',TESTS.'app'.DS.'controllers'.DS); /** * Path to the helpers test directory. */ -define ('HELPER_TESTS', TESTS.'app'.DS.'helpers'.DS); +define ('HELPER_TESTS', TESTS.'app'.DS.'helpers'.DS); /** * Path to the models' test directory. */ -define ('MODEL_TESTS', TESTS.'app'.DS.'models'.DS); +define ('MODEL_TESTS', TESTS.'app'.DS.'models'.DS); /** * Path to the lib test directory. */ -define ('LIB_TESTS', TESTS.'libs'.DS); +define ('LIB_TESTS', TESTS.'libs'.DS); + +/** + * Path to the vendors directory. + */ +define ('VENDORS', ROOT.'vendors'.DS); + +/** + * Path to the Pear directory + * The purporse is to make it easy porting Pear libs into Cake + * without setting the include_path PHP variable. + */ +define ('PEAR', VENDORS.'Pear'.DS); ?> diff --git a/config/routes.php b/config/routes.php index b0f5c089d..f4125e6da 100644 --- a/config/routes.php +++ b/config/routes.php @@ -12,6 +12,9 @@ * In this file, you set up routes to your controllers and their actions. * Routes are very important mechanism that allows you to freely connect * different urls to chosen controllers and their actions (functions). + * + * @package cake + * @subpackage cake.config */ /** diff --git a/config/routes.php.default b/config/routes.php.default index 60132d9dc..010eac59e 100644 --- a/config/routes.php.default +++ b/config/routes.php.default @@ -12,6 +12,9 @@ * In this file, you set up routes to your controllers and their actions. * Routes are very important mechanism that allows you to freely connect * different urls to chosen controllers and their actions (functions). + * + * @package cake + * @subpackage cake.config */ /** diff --git a/config/tags.php b/config/tags.php index 325db78dd..1d14daf22 100644 --- a/config/tags.php +++ b/config/tags.php @@ -11,6 +11,9 @@ /** * In this file, you can set up 'templates' for every tag generated by the tag * generator. + * + * @package cake + * @subpackage cake.config */ /**