Adds a phpdoc define to assist the ide in locating includes/requires

[exponentcms#199]
karamdeep-singh · Jul 26, 2011 · b1657d1 · b1657d1
1 parent 1a8c22a
commit b1657d1
Show file tree

Hide file tree

Showing 192 changed files with 222 additions and 14 deletions.
diff --git a/cron/bootstrap.php b/cron/bootstrap.php
@@ -41,6 +41,8 @@
 
     //define('BASE',str_ireplace('/cron','',__realpath(dirname(__FILE__))));
     define("EXP_PATH", BASE);
+/** @define "EXP_PATH" ".." */
+
     //Pull in the mysqli helper class form exponet. 
     // Sure, we could have used mysqli directly but we have this nice friendly class so why not use it
     require_once(EXP_PATH . "subsystems/database/mysqli.php");

diff --git a/datatypes/calendar.php b/datatypes/calendar.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class calendar {
 	function form($object) {

diff --git a/datatypes/calendarmodule_config.php b/datatypes/calendarmodule_config.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class calendarmodule_config {
 	function form($object) {

diff --git a/datatypes/database_importer.php b/datatypes/database_importer.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class database_importer {
 	function form() {

diff --git a/datatypes/file.php b/datatypes/file.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class file {
 	function update($name,$dest,$object,$destname = null,$force=false) {

diff --git a/datatypes/file_collection.php b/datatypes/file_collection.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class file_collection {
 	function form($object) {

diff --git a/datatypes/formbuilder_form.php b/datatypes/formbuilder_form.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class formbuilder_form {
 	function form($object) {

diff --git a/datatypes/formbuilder_report.php b/datatypes/formbuilder_report.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class formbuilder_report {
 	function form($object) {

diff --git a/datatypes/poll_answer.php b/datatypes/poll_answer.php
@@ -30,6 +30,7 @@
 #
 # $Id: poll_answer.php,v 1.2 2005/04/25 19:02:17 filetreefrog Exp $
 ##################################################
+/** @define "BASE" ".." */
 
 class poll_answer {
 	function form($object) {

diff --git a/datatypes/poll_question.php b/datatypes/poll_question.php
@@ -30,6 +30,7 @@
 #
 # $Id: poll_question.php,v 1.3 2005/04/25 19:02:17 filetreefrog Exp $
 ##################################################
+/** @define "BASE" ".." */
 
 class poll_question {
 	function form($object) {

diff --git a/datatypes/rssfeed.php b/datatypes/rssfeed.php
@@ -29,6 +29,8 @@ function (refreshRSS()) in a datatype ($datetype)
 if (!defined('MAGPIE_OUTPUT_ENCODING')) {
     define('MAGPIE_OUTPUT_ENCODING', 'UTF-8');
 }
+
+/** @define "MAGPIE_DIR" "../external/magpierss/" */
 require_once(MAGPIE_DIR.'rss_fetch.inc');
 require_once(MAGPIE_DIR.'rss_utils.inc');
 define('MAGPIE_CACHE_DIR', BASE.'tmp/rsscache');

diff --git a/datatypes/section.php b/datatypes/section.php
@@ -15,6 +15,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class section {
 	/*

diff --git a/datatypes/section_template.php b/datatypes/section_template.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" ".." */
 
 class section_template {
 	function form($object = null) {

diff --git a/datatypes/simplepollmodule_config.php b/datatypes/simplepollmodule_config.php
@@ -30,6 +30,7 @@
 #
 # $Id: simplepollmodule_config.php,v 1.2 2005/04/25 19:02:17 filetreefrog Exp $
 ##################################################
+/** @define "BASE" ".." */
 
 class simplepollmodule_config {
 	function form($object) {

diff --git a/exponent.js.php b/exponent.js.php
@@ -17,6 +17,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "." */
 
 //Initialize exponent Framework
 //include_once('exponent_common.php');  // incorporated into exponent_bootstrap.php

diff --git a/exponent.php b/exponent.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "." */
 
 /**
  * The file that initializes everything

diff --git a/exponent_bootstrap.php b/exponent_bootstrap.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "." */
 
 // Following code taken from http://us4.php.net/manual/en/function.get-magic-quotes-gpc.php
 //   - it allows magic_quotes to be on without screwing stuff up.
@@ -71,7 +72,7 @@ function __realpath($path) {
 define('EXPONENT', '1');
 
 // load the constants from the global config, theme config, and then default config settings
-require_once(BASE . '/subsystems/config/load.php');
+require_once(BASE . 'subsystems/config/load.php');
 
 // define remaining constants throughout the system based on loaded configuration constants
 

diff --git a/framework/core/datatypes/expFile.php b/framework/core/datatypes/expFile.php
@@ -15,6 +15,7 @@
  * @author Adam Kessler <adam@oicgroup.net>
  * @version 2.0.0
  */
+/** @define "BASE" "../../.." */
 
  /**
   * Class to handle files at the File System Level and updating

diff --git a/framework/core/datatypes/expRss.php b/framework/core/datatypes/expRss.php
@@ -21,7 +21,8 @@
  * @subpackage Core-Datatypes
  * @package Framework
  */
-
+/** @define "BASE" "../../../" */
+
 class expRss extends expRecord {
     public $table = 'expRss';
     protected $attachable_item_types = array(

diff --git a/framework/core/subsystems/expJavascript.php b/framework/core/subsystems/expJavascript.php
@@ -15,6 +15,9 @@
  * @author Adam Kessler <adam@oicgroup.net>
  * @version 2.0.0
  */
+/** @define "BASE" "../../.." */
+
+
 /**
  * This is the class expJavascript
  *

diff --git a/framework/core/subsystems/expLang.php b/framework/core/subsystems/expLang.php
@@ -15,6 +15,9 @@
  * @author Phillip Ball <phillip@oicgroup.net>
  * @version 2.0.0
  */
+/** @define "BASE" "../../.." */
+
+
 /**
  * This is the class expLang
  *

diff --git a/framework/core/subsystems/expValidator.php b/framework/core/subsystems/expValidator.php
@@ -15,6 +15,8 @@
  * @author Adam Kessler <adam@oicgroup.net>
  * @version 2.0.0
  */
+/** @define "BASE" "../../.." */
+
 /**
  * This is the class expValidator
  *

diff --git a/framework/datatypes/keywords.php b/framework/datatypes/keywords.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../.." */
 
 class keywords {
 

diff --git a/framework/modules/administration/controllers/administrationController.php b/framework/modules/administration/controllers/administrationController.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../.." */
 
 class administrationController extends expController {
     public $basemodel_name = 'expRecord';

diff --git a/framework/modules/ecommerce/billingcalculators/cash.php b/framework/modules/ecommerce/billingcalculators/cash.php
@@ -1,4 +1,5 @@
 <?php
+/** @define "BASE" "../../../.." */
 
 class cash extends billingcalculator{
 	function name() { return "Cash/Check"; }

diff --git a/framework/modules/ecommerce/billingcalculators/passthru.php b/framework/modules/ecommerce/billingcalculators/passthru.php
@@ -1,4 +1,5 @@
 <?php
+/** @define "BASE" "../../../.." */
 
 class passthru extends billingcalculator {
 	function name() { return "Passthru Payment"; }

diff --git a/framework/modules/ecommerce/controllers/ecomconfigController.php b/framework/modules/ecommerce/controllers/ecomconfigController.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../.." */
 
 class ecomconfigController extends expController {
 	//public $basemodel_name = 'expRecord';

diff --git a/framework/modules/ecommerce/controllers/storeController.php b/framework/modules/ecommerce/controllers/storeController.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../.." */
 
 class storeController extends expController {
     public $basemodel_name = 'product';

diff --git a/framework/modules/ecommerce/products/datatypes/product.php b/framework/modules/ecommerce/products/datatypes/product.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../../.." */
 
 class product extends expRecord {
 	public $table = 'product';

diff --git a/framework/modules/ecommerce/shippingcalculators/fedexcalculator.php b/framework/modules/ecommerce/shippingcalculators/fedexcalculator.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../.." */
 
 class fedexcalculator extends shippingcalculator {
 	/*

diff --git a/framework/modules/ecommerce/shippingcalculators/upscalculator.php b/framework/modules/ecommerce/shippingcalculators/upscalculator.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../.." */
 
 class upscalculator extends shippingcalculator {
 	/*

diff --git a/framework/modules/motd/controllers/motdController.php b/framework/modules/motd/controllers/motdController.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../.." */
 
 class motdController extends expController {
     //public $basemodel_name = '';

diff --git a/framework/modules/users/controllers/usersController.php b/framework/modules/users/controllers/usersController.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../../.." */
 
 class usersController extends expController {
     public $basemodel_name = 'user';

diff --git a/index.php b/index.php
@@ -17,6 +17,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "." */
 
 define('SCRIPT_EXP_RELATIVE','');
 define('SCRIPT_FILENAME','index.php');

diff --git a/login.php b/login.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "." */
 
 // Initialize the Exponent Framework
 require_once('exponent.php');

diff --git a/modules/administrationmodule/actions/config_activate.php b/modules/administrationmodule/actions/config_activate.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the Configuration category
 

diff --git a/modules/administrationmodule/actions/config_configuresite.php b/modules/administrationmodule/actions/config_configuresite.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the Configuration category
 

diff --git a/modules/administrationmodule/actions/config_delete.php b/modules/administrationmodule/actions/config_delete.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the Configuration category
 if (!defined('EXPONENT')) exit('');

diff --git a/modules/administrationmodule/actions/config_save.php b/modules/administrationmodule/actions/config_save.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the Configuration category
 

diff --git a/modules/administrationmodule/actions/configuresite.php b/modules/administrationmodule/actions/configuresite.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the Configuration category
 

diff --git a/modules/administrationmodule/actions/finish_install_extension.php b/modules/administrationmodule/actions/finish_install_extension.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the Extensions category
 

diff --git a/modules/administrationmodule/actions/gmgr_delete.php b/modules/administrationmodule/actions/gmgr_delete.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the User Management category
 

diff --git a/modules/administrationmodule/actions/gmgr_editprofile.php b/modules/administrationmodule/actions/gmgr_editprofile.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the User Management category
 

diff --git a/modules/administrationmodule/actions/gmgr_membership.php b/modules/administrationmodule/actions/gmgr_membership.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the User Management category
 

diff --git a/modules/administrationmodule/actions/gmgr_savegroup.php b/modules/administrationmodule/actions/gmgr_savegroup.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the User Management category
 

diff --git a/modules/administrationmodule/actions/groupaccounts.php b/modules/administrationmodule/actions/groupaccounts.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the User Management categry
 

diff --git a/modules/administrationmodule/actions/install_extension.php b/modules/administrationmodule/actions/install_extension.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 // Part of the Extensions category
 

diff --git a/modules/administrationmodule/actions/installtables.php b/modules/administrationmodule/actions/installtables.php
@@ -16,6 +16,7 @@
 # GPL: http://www.gnu.org/licenses/gpl.txt
 #
 ##################################################
+/** @define "BASE" "../../.." */
 
 if (!defined('EXPONENT')) exit('');