CRM/Core add missing comment blocks (autogenerated)
authorEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 02:57:15 +0000 (14:57 +1200)
committerEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 02:57:15 +0000 (14:57 +1200)
65 files changed:
CRM/Core/BAO/File.php
CRM/Core/Block.php
CRM/Core/ClassLoader.php
CRM/Core/Component.php
CRM/Core/Component/Info.php
CRM/Core/Controller.php
CRM/Core/Controller/Simple.php
CRM/Core/DAO.php
CRM/Core/DAO/Factory.php
CRM/Core/Error.php
CRM/Core/Exception.php
CRM/Core/Form.php
CRM/Core/I18n/NativeGettext.php
CRM/Core/I18n/PseudoConstant.php
CRM/Core/I18n/Schema.php
CRM/Core/I18n/SchemaStructure_2_2_0.php
CRM/Core/I18n/SchemaStructure_3_0_alpha1.php
CRM/Core/I18n/SchemaStructure_3_0_beta1.php
CRM/Core/I18n/SchemaStructure_3_0_beta4.php
CRM/Core/I18n/SchemaStructure_3_1_alpha1.php
CRM/Core/I18n/SchemaStructure_3_1_beta2.php
CRM/Core/I18n/SchemaStructure_3_2_beta4.php
CRM/Core/I18n/SchemaStructure_3_3_beta1.php
CRM/Core/I18n/SchemaStructure_3_4_0.php
CRM/Core/I18n/SchemaStructure_3_4_beta2.php
CRM/Core/I18n/SchemaStructure_3_4_beta3.php
CRM/Core/I18n/SchemaStructure_4_1_0.php
CRM/Core/I18n/SchemaStructure_4_1_alpha1.php
CRM/Core/I18n/SchemaStructure_4_2_alpha1.php
CRM/Core/I18n/SchemaStructure_4_3_1.php
CRM/Core/I18n/SchemaStructure_4_5_alpha1.php
CRM/Core/Invoke.php
CRM/Core/JobManager.php
CRM/Core/Key.php
CRM/Core/Lock.php
CRM/Core/ManagedEntities.php
CRM/Core/Menu.php
CRM/Core/Module.php
CRM/Core/OptionGroup.php
CRM/Core/Page.php
CRM/Core/Page/Angular.php
CRM/Core/Page/Basic.php
CRM/Core/Payment.php
CRM/Core/Permission.php
CRM/Core/Permission/DrupalBase.php
CRM/Core/PseudoConstant.php
CRM/Core/QuickForm/Action/Upload.php
CRM/Core/Reference/Basic.php
CRM/Core/Reference/Dynamic.php
CRM/Core/Reference/OptionValue.php
CRM/Core/Region.php
CRM/Core/Report/Excel.php
CRM/Core/Resources.php
CRM/Core/ScheduledJob.php
CRM/Core/Selector/Base.php
CRM/Core/Selector/Controller.php
CRM/Core/Session.php
CRM/Core/Smarty.php
CRM/Core/Smarty/Permissions.php
CRM/Core/Smarty/plugins/block.crmScope.php
CRM/Core/Smarty/resources/String.php
CRM/Core/StateMachine.php
CRM/Core/TableHierarchy.php
CRM/Core/TemporaryErrorScope.php
CRM/Core/Transaction.php

index c1bd7a08f7068842848b70d76c76beec12f9f86b..db765e5627b5842333c1566240351904aa3a1c11 100644 (file)
     }
   }
 
-  static function deleteURLArgs($entityTable, $entityID, $fileID) {
+   /**
+    * @param $entityTable
+    * @param $entityID
+    * @param $fileID
+    *
+    * @return string
+    */
+   static function deleteURLArgs($entityTable, $entityID, $fileID) {
     $params['entityTable'] = $entityTable;
     $params['entityID']    = $entityID;
     $params['fileID']      = $fileID;
index 04c12f5040f64712299bdc230194899ca7107466..b191735ea780dc5bc7711dca81e0d1a1c60414fa 100644 (file)
@@ -431,6 +431,11 @@ class CRM_Core_Block {
     self::setProperty(self::CREATE_NEW, 'templateValues', array('shortCuts' => $values));
   }
 
+  /**
+   * @param $short
+   *
+   * @return array
+   */
   private static function setShortcutValues($short) {
     $value = array();
     if (isset($short['url'])) {
index b2f1c0afd3ee87be70af7c0121c114df779a2f13..630a16b3eecf4b579a95c5816fe23cab0fa2b7fd 100644 (file)
@@ -43,6 +43,11 @@ class CRM_Core_ClassLoader {
    */
   private static $_singleton = NULL;
 
+  /**
+   * @param bool $force
+   *
+   * @return object
+   */
   static function &singleton($force = FALSE) {
     if ($force || self::$_singleton === NULL) {
       self::$_singleton = new CRM_Core_ClassLoader();
@@ -55,6 +60,9 @@ class CRM_Core_ClassLoader {
    */
   protected $_registered;
 
+  /**
+   *
+   */
   protected function __construct() {
     $this->_registered = FALSE;
   }
@@ -114,6 +122,9 @@ class CRM_Core_ClassLoader {
     require_once "$civicrm_base_path/packages/vendor/autoload.php";
   }
 
+  /**
+   * @param $class
+   */
   function loadClass($class) {
     if (
       // Only load classes that clearly belong to CiviCRM.
index f5e5ea6a7758548a9705c0540d38a469b3cbc8e6..c5c49a6a4ffee83ceb4c1c77f71f46e4e326768a 100644 (file)
@@ -46,6 +46,11 @@ class CRM_Core_Component {
 
   static $_contactSubTypes = NULL;
 
+  /**
+   * @param bool $force
+   *
+   * @return array|null
+   */
   private static function &_info($force = FALSE) {
     if (self::$_info == NULL || $force) {
       self::$_info = array();
@@ -64,6 +69,12 @@ class CRM_Core_Component {
     return self::$_info;
   }
 
+  /**
+   * @param $name
+   * @param null $attribute
+   *
+   * @return mixed
+   */
   static function get($name, $attribute = NULL) {
     $comp = CRM_Utils_Array::value($name, self::_info());
     if ($attribute) {
@@ -72,6 +83,12 @@ class CRM_Core_Component {
     return $comp;
   }
 
+  /**
+   * @param bool $force
+   *
+   * @return array
+   * @throws Exception
+   */
   public static function &getComponents($force = FALSE) {
     static $_cache = NULL;
 
@@ -95,6 +112,11 @@ class CRM_Core_Component {
     return $_cache;
   }
 
+  /**
+   * @param bool $force
+   *
+   * @return array|null
+   */
   static public function &getEnabledComponents($force = FALSE) {
     return self::_info($force);
   }
@@ -103,6 +125,11 @@ class CRM_Core_Component {
     self::getEnabledComponents(TRUE);
   }
 
+  /**
+   * @param bool $translated
+   *
+   * @return array
+   */
   public static function &getNames($translated = FALSE) {
     $allComponents = self::getComponents();
 
@@ -118,6 +145,12 @@ class CRM_Core_Component {
     return $names;
   }
 
+  /**
+   * @param $args
+   * @param $type
+   *
+   * @return bool
+   */
   static function invoke(&$args, $type) {
     $info = self::_info();
     $config = CRM_Core_Config::singleton();
@@ -150,6 +183,9 @@ class CRM_Core_Component {
     return FALSE;
   }
 
+  /**
+   * @return array
+   */
   static function xmlMenu() {
 
     // lets build the menu for all components
@@ -165,6 +201,9 @@ class CRM_Core_Component {
     return $files;
   }
 
+  /**
+   * @return array
+   */
   static function &menu() {
     $info = self::_info();
     $items = array();
@@ -180,6 +219,10 @@ class CRM_Core_Component {
     return $items;
   }
 
+  /**
+   * @param $config
+   * @param bool $oldMode
+   */
   static function addConfig(&$config, $oldMode = FALSE) {
     $info = self::_info();
 
@@ -190,12 +233,22 @@ class CRM_Core_Component {
     return;
   }
 
+  /**
+   * @param $componentName
+   *
+   * @return mixed
+   */
   static function getComponentID($componentName) {
     $info = self::_info();
 
     return $info[$componentName]->componentID;
   }
 
+  /**
+   * @param $componentID
+   *
+   * @return int|null|string
+   */
   static function getComponentName($componentID) {
     $info = self::_info();
 
@@ -210,6 +263,9 @@ class CRM_Core_Component {
     return $componentName;
   }
 
+  /**
+   * @return array
+   */
   static function &getQueryFields() {
     $info = self::_info();
     $fields = array();
@@ -223,6 +279,10 @@ class CRM_Core_Component {
     return $fields;
   }
 
+  /**
+   * @param $query
+   * @param $fnName
+   */
   static function alterQuery(&$query, $fnName) {
     $info = self::_info();
 
@@ -234,6 +294,13 @@ class CRM_Core_Component {
     }
   }
 
+  /**
+   * @param $fieldName
+   * @param $mode
+   * @param $side
+   *
+   * @return null
+   */
   static function from($fieldName, $mode, $side) {
     $info = self::_info();
 
@@ -250,6 +317,12 @@ class CRM_Core_Component {
     return $from;
   }
 
+  /**
+   * @param $mode
+   * @param bool $includeCustomFields
+   *
+   * @return null
+   */
   static function &defaultReturnProperties($mode,
     $includeCustomFields = TRUE
   ) {
@@ -268,6 +341,9 @@ class CRM_Core_Component {
     return $properties;
   }
 
+  /**
+   * @param $form
+   */
   static function &buildSearchForm(&$form) {
     $info = self::_info();
 
@@ -279,6 +355,10 @@ class CRM_Core_Component {
     }
   }
 
+  /**
+   * @param $row
+   * @param $id
+   */
   static function searchAction(&$row, $id) {
     $info = self::_info();
 
@@ -290,6 +370,9 @@ class CRM_Core_Component {
     }
   }
 
+  /**
+   * @return array|null
+   */
   static function &contactSubTypes() {
     if (self::$_contactSubTypes == NULL) {
       self::$_contactSubTypes = array();
@@ -298,6 +381,12 @@ class CRM_Core_Component {
   }
 
 
+  /**
+   * @param $subType
+   * @param $op
+   *
+   * @return null
+   */
   static function &contactSubTypeProperties($subType, $op) {
     $properties = self::contactSubTypes();
     if (array_key_exists($subType, $properties) &&
index cfdc1bb40fb2586c62cdf43b37f031dc32646bf3..c9433c5c34fe4f5b337f173d7e0181d8fd1bff03 100644 (file)
@@ -107,6 +107,11 @@ abstract class CRM_Core_Component_Info {
    * @access public
    *
    */
+  /**
+   * @param $name
+   * @param $namespace
+   * @param $componentID
+   */
   public function __construct($name, $namespace, $componentID) {
     $this->name        = $name;
     $this->namespace   = $namespace;
index c484164d35e6335406139b053539a3262a32b3e4..e9c7b031be5463f23f1e6d7b1e2335fbc4eefd75 100644 (file)
@@ -289,6 +289,13 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     );
   }
 
+  /**
+   * @param $name
+   * @param bool $addSequence
+   * @param bool $ignoreKey
+   *
+   * @return mixed|string
+   */
   function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
     $config = CRM_Core_Config::singleton();
 
@@ -349,6 +356,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     return $this->_pages[$pageName]->handle($action);
   }
 
+  /**
+   * @return bool
+   */
   function validate() {
     $this->_actionName = $this->getActionName();
     list($pageName, $action) = $this->_actionName;
@@ -584,6 +594,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     return $wizard;
   }
 
+  /**
+   * @param $wizard
+   */
   function addWizardStyle(&$wizard) {
     $wizard['style'] = array(
       'barClass' => '',
@@ -692,6 +705,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     return $this->_skipRedirection;
   }
 
+  /**
+   * @param null $fileName
+   */
   function setWord($fileName = NULL) {
     //Mark as a CSV file.
     header('Content-Type: application/vnd.ms-word');
@@ -703,6 +719,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     header("Content-Disposition: attachment; filename=Contacts_$fileName");
   }
 
+  /**
+   * @param null $fileName
+   */
   function setExcel($fileName = NULL) {
     //Mark as an excel file.
     header('Content-Type: application/vnd.ms-excel');
@@ -743,6 +762,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     return $this->_print;
   }
 
+  /**
+   * @return string
+   */
   function getTemplateFile() {
     if ($this->_print) {
       if ($this->_print == CRM_Core_Smarty::PRINT_PAGE) {
@@ -761,6 +783,10 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     }
   }
 
+  /**
+   * @param $uploadDir
+   * @param $uploadNames
+   */
   public function addUploadAction($uploadDir, $uploadNames) {
     if (empty($uploadDir)) {
       $config = CRM_Core_Config::singleton();
@@ -786,18 +812,31 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     $this->addAction('upload', $action);
   }
 
+  /**
+   * @param $parent
+   */
   public function setParent($parent) {
     $this->_parent = $parent;
   }
 
+  /**
+   * @return object
+   */
   public function getParent() {
     return $this->_parent;
   }
 
+  /**
+   * @return string
+   */
   public function getDestination() {
     return $this->_destination;
   }
 
+  /**
+   * @param null $url
+   * @param bool $setToReferer
+   */
   public function setDestination($url = NULL, $setToReferer = FALSE) {
     if (empty($url)) {
       if ($setToReferer) {
@@ -813,6 +852,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
     $this->set('civicrmDestination', $this->_destination);
   }
 
+  /**
+   * @return mixed
+   */
   public function cancelAction() {
     $actionName = $this->getActionName();
     list($pageName, $action) = $actionName;
index 5fb151bed8f6021851d74c9a79f6e51fd9601d2b..7dafbf7f64054da8f20f856ae25ea03e2a194861 100644 (file)
@@ -109,10 +109,16 @@ class CRM_Core_Controller_Simple extends CRM_Core_Controller {
     }
   }
 
+  /**
+   * @param $parent
+   */
   public function setParent($parent) {
     $this->_parent = $parent;
   }
 
+  /**
+   * @return mixed
+   */
   public function getTemplateFileName() {
     // there is only one form here, so should be quite easy
     $actionName = $this->getActionName();
index d5e23631b64e086462a1f6d08029f04003ea07d6..f6eaaec768c728013413ec358793b1814fb74650 100644 (file)
@@ -135,6 +135,11 @@ class CRM_Core_DAO extends DB_DataObject {
     $this->joinAdd();
   }
 
+  /**
+   * @param $tableName
+   *
+   * @return string
+   */
   static function getLocaleTableName($tableName) {
     global $dbLocale;
     if ($dbLocale) {
@@ -283,6 +288,9 @@ class CRM_Core_DAO extends DB_DataObject {
     return $table;
   }
 
+  /**
+   * @return $this
+   */
   function save() {
     if (!empty($this->id)) {
       $this->update();
@@ -297,6 +305,9 @@ class CRM_Core_DAO extends DB_DataObject {
     return $this;
   }
 
+  /**
+   * @param bool $created
+   */
   function log($created = FALSE) {
     static $cid = NULL;
 
@@ -471,6 +482,11 @@ class CRM_Core_DAO extends DB_DataObject {
     return NULL;
   }
 
+  /**
+   * @param $type
+   *
+   * @throws Exception
+   */
   static function transaction($type) {
     CRM_Core_Error::fatal('This function is obsolete, please use CRM_Core_Transaction');
   }
@@ -574,6 +590,11 @@ LIKE %1
     return $values;
   }
 
+  /**
+   * @param int $maxTablesToCheck
+   *
+   * @return bool
+   */
   static function isDBMyISAM($maxTablesToCheck = 10) {
     // show error if any of the tables, use 'MyISAM' storage engine.
     $engines = self::getStorageValues(NULL, $maxTablesToCheck);
@@ -731,6 +752,11 @@ LIKE %1
     return $result;
   }
 
+  /**
+   * @param $version
+   *
+   * @return bool
+   */
   function checkVersion($version) {
     $query = "
 SELECT version
@@ -986,6 +1012,14 @@ FROM   civicrm_domain
     return $ret;
   }
 
+  /**
+   * @param $query
+   * @param $params
+   * @param bool $abort
+   *
+   * @return string
+   * @throws Exception
+   */
   static function composeQuery($query, &$params, $abort = TRUE) {
     $tr = array();
     foreach ($params as $key => $item) {
@@ -1030,6 +1064,9 @@ FROM   civicrm_domain
     return strtr($query, $tr);
   }
 
+  /**
+   * @param null $ids
+   */
   static function freeResult($ids = NULL) {
     global $_DB_DATAOBJECT;
 
@@ -1239,6 +1276,11 @@ SELECT contact_id
     );
   }
 
+  /**
+   * @param $string
+   *
+   * @return string
+   */
   static function escapeString($string) {
     static $_dao = NULL;
 
@@ -1270,6 +1312,11 @@ SELECT contact_id
     return '"' . implode('","', $escapes) . '"';
   }
 
+  /**
+   * @param $string
+   *
+   * @return string
+   */
   static function escapeWildCardString($string) {
     // CRM-9155
     // ensure we escape the single characters % and _ which are mysql wild
@@ -1506,6 +1553,13 @@ SELECT contact_id
   }
   }
 
+  /**
+   * @param string $prefix
+   * @param bool $addRandomString
+   * @param null $string
+   *
+   * @return string
+   */
   static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
     $tableName = $prefix . "_temp";
 
@@ -1520,6 +1574,12 @@ SELECT contact_id
     return $tableName;
   }
 
+  /**
+   * @param bool $view
+   * @param bool $trigger
+   *
+   * @return bool
+   */
   static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
     // test for create view and trigger permissions and if allowed, add the option to go multilingual
     // and logging
@@ -1561,6 +1621,10 @@ SELECT contact_id
     return TRUE;
   }
 
+  /**
+   * @param null $message
+   * @param bool $printDAO
+   */
   static function debugPrint($message = NULL, $printDAO = TRUE) {
     CRM_Utils_System::xMemory("{$message}: ");
 
@@ -1790,6 +1854,9 @@ SELECT contact_id
     return $occurrences;
   }
 
+  /**
+   * @return array
+   */
   function getReferenceCounts() {
     $links = self::getReferencesToTable(static::getTableName());
 
@@ -2073,6 +2140,9 @@ SELECT contact_id
     return substr($string, 0, $length - 8) . "_{$md5string}";
   }
 
+  /**
+   * @param $params
+   */
   function setApiFilter(&$params) {}
 
 }
index 52fb080851fd545b03f9868f7e2ed9ca63220faf..b389988335fd08c08063222159a0170ef23516eb 100644 (file)
@@ -22,6 +22,12 @@ class CRM_Core_DAO_Factory {
 
   static $_suffix = '.php';
 
+  /**
+   * @param $className
+   *
+   * @return mixed
+   * @throws Exception
+   */
   static function &create($className) {
     $type = CRM_Utils_Array::value($className, self::$_classes);
     if (!$type) {
index 99af198c10a43875ec110f901c475870b5b0b69d..05ec54b7878dd59800b624d4b8f171f82123011e 100644 (file)
@@ -66,6 +66,9 @@ class CRM_Exception extends PEAR_Exception {
   }
 }
 
+/**
+ * Class CRM_Core_Error
+ */
 class CRM_Core_Error extends PEAR_ErrorStack {
 
   /**
@@ -130,6 +133,12 @@ class CRM_Core_Error extends PEAR_ErrorStack {
     $this->setDefaultCallback(array($this, 'handlePES'));
   }
 
+  /**
+   * @param $error
+   * @param string $separator
+   *
+   * @return array|null|string
+   */
   static public function getMessages(&$error, $separator = '<br />') {
     if (is_a($error, 'CRM_Core_Error')) {
       $errors = $error->getErrors();
@@ -244,6 +253,9 @@ class CRM_Core_Error extends PEAR_ErrorStack {
   // this function is used to trap and print errors
   // during system initialization time. Hence the error
   // message is quite ugly
+  /**
+   * @param $pearError
+   */
   public static function simpleHandler($pearError) {
 
     // create the error array
@@ -643,6 +655,10 @@ class CRM_Core_Error extends PEAR_ErrorStack {
     return Log::singleton('file', $fileName);
   }
 
+  /**
+   * @param string $msg
+   * @param bool $log
+   */
   static function backtrace($msg = 'backTrace', $log = FALSE) {
     $backTrace = debug_backtrace();
     $message = self::formatBacktrace($backTrace);
@@ -793,6 +809,14 @@ class CRM_Core_Error extends PEAR_ErrorStack {
     return $msg;
   }
 
+  /**
+   * @param $message
+   * @param int $code
+   * @param string $level
+   * @param null $params
+   *
+   * @return object
+   */
   static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) {
     $error = CRM_Core_Error::singleton();
     $error->push($code, $level, array($params), $message);
@@ -864,6 +888,13 @@ class CRM_Core_Error extends PEAR_ErrorStack {
    * This function is no longer used by v3 api.
    * @fixme Some core files call it but it should be re-thought & renamed or removed
    */
+  /**
+   * @param $msg
+   * @param null $data
+   *
+   * @return array
+   * @throws Exception
+   */
   public static function &createAPIError($msg, $data = NULL) {
     if (self::$modeException) {
       throw new Exception($msg, $data);
@@ -879,6 +910,9 @@ class CRM_Core_Error extends PEAR_ErrorStack {
     return $values;
   }
 
+  /**
+   * @param $file
+   */
   public static function movedSiteError($file) {
     $url = CRM_Utils_System::url('civicrm/admin/setting/updateConfigBackend',
       'reset=1',
@@ -899,6 +933,12 @@ class CRM_Core_Error extends PEAR_ErrorStack {
     CRM_Utils_System::civiExit($code);
   }
 
+  /**
+   * @param $error
+   * @param const $type
+   *
+   * @return bool
+   */
   public static function isAPIError($error, $type = CRM_Core_Error::FATAL_ERROR) {
     if (is_array($error) && !empty($error['is_error'])) {
       $code = $error['error_message']['code'];
index f6e8dfea670a2f5f07be413d705bd10d789c259d..ea319b57369d3df30587d0e0d08959c1df130b4e 100644 (file)
 
 class CRM_Core_Exception extends PEAR_Exception {
   private $errorData = array();
+
+  /**
+   * @param $message
+   * @param int $error_code
+   * @param array $errorData
+   * @param null $previous
+   */
   public function __construct($message, $error_code = 0, $errorData = array(), $previous = null) {
     parent::__construct(ts($message));
     $this->errorData = $errorData + array('error_code' => $error_code);
   }
 
   // custom string representation of object
+  /**
+   * @return string
+   */
   public function __toString() {
     return __CLASS__ . ": [{$this->errorData['error_code']}: {$this->message}\n";
   }
index f2970595c34e2adb7bfff784779ef61b93989d36..89c88a26dcd8f6a1a04748e01b99251a84119ade 100644 (file)
@@ -816,6 +816,16 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     return self::$_template->get_template_vars($name);
   }
 
+  /**
+   * @param $name
+   * @param $title
+   * @param $values
+   * @param array $attributes
+   * @param null $separator
+   * @param bool $required
+   *
+   * @return HTML_QuickForm_group
+   */
   function &addRadio($name, $title, $values, $attributes = array(), $separator = NULL, $required = FALSE) {
     $options = array();
     $attributes = $attributes ? $attributes : array();
@@ -835,6 +845,13 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     return $group;
   }
 
+  /**
+   * @param $id
+   * @param $title
+   * @param bool $allowClear
+   * @param null $required
+   * @param array $attributes
+   */
   function addYesNo($id, $title, $allowClear = FALSE, $required = NULL, $attributes = array()) {
     $attributes += array('id_suffix' => $id);
     $choice   = array();
@@ -850,6 +867,17 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     }
   }
 
+  /**
+   * @param $id
+   * @param $title
+   * @param $values
+   * @param null $other
+   * @param null $attributes
+   * @param null $required
+   * @param null $javascriptMethod
+   * @param string $separator
+   * @param bool $flipValues
+   */
   function addCheckBox($id, $title, $values, $other = NULL,
     $attributes       = NULL, $required = NULL,
     $javascriptMethod = NULL,
@@ -932,6 +960,15 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     $this->addButtons($buttons);
   }
 
+  /**
+   * @param $name
+   * @param string $from
+   * @param string $to
+   * @param string $label
+   * @param string $dateFormat
+   * @param bool $required
+   * @param bool $displayTime
+   */
   function addDateRange($name, $from = '_from', $to = '_to', $label = 'From:', $dateFormat = 'searchDate', $required = FALSE, $displayTime = FALSE) {
     if ($displayTime) {
       $this->addDateTime($name . $from, $label, $required, array('formatType' => $dateFormat));
@@ -1026,6 +1063,12 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     ));
   }
 
+  /**
+   * @param $name
+   * @param $label
+   * @param $attributes
+   * @param bool $forceTextarea
+   */
   function addWysiwyg($name, $label, $attributes, $forceTextarea = FALSE) {
     // 1. Get configuration option for editor (tinymce, ckeditor, pure textarea)
     // 2. Based on the option, initialise proper editor
@@ -1064,6 +1107,12 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     $this->assign('includeWysiwygEditor', $includeWysiwygEditor);
   }
 
+  /**
+   * @param $id
+   * @param $title
+   * @param null $required
+   * @param null $extra
+   */
   function addCountry($id, $title, $required = NULL, $extra = NULL) {
     $this->addElement('select', $id, $title,
       array(
@@ -1074,6 +1123,14 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     }
   }
 
+  /**
+   * @param $name
+   * @param $label
+   * @param $options
+   * @param $attributes
+   * @param null $required
+   * @param null $javascriptMethod
+   */
   function addSelectOther($name, $label, $options, $attributes, $required = NULL, $javascriptMethod = NULL) {
 
     $this->addElement('select', $name . '_id', $label, $options, $javascriptMethod);
@@ -1083,18 +1140,30 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     }
   }
 
+  /**
+   * @return null
+   */
   public function getRootTitle() {
     return NULL;
   }
 
+  /**
+   * @return string
+   */
   public function getCompleteTitle() {
     return $this->getRootTitle() . $this->getTitle();
   }
 
+  /**
+   * @return CRM_Core_Smarty
+   */
   static function &getTemplate() {
     return self::$_template;
   }
 
+  /**
+   * @param $elementName
+   */
   function addUploadElement($elementName) {
     $uploadNames = $this->get('uploadNames');
     if (!$uploadNames) {
@@ -1120,6 +1189,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     }
   }
 
+  /**
+   * @return string
+   */
   function buttonType() {
     $uploadNames = $this->get('uploadNames');
     $buttonType = (is_array($uploadNames) && !empty($uploadNames)) ? 'upload' : 'next';
@@ -1127,10 +1199,19 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     return $buttonType;
   }
 
+  /**
+   * @param $name
+   *
+   * @return null
+   */
   function getVar($name) {
     return isset($this->$name) ? $this->$name : NULL;
   }
 
+  /**
+   * @param $name
+   * @param $value
+   */
   function setVar($name, $value) {
     $this->$name = $value;
   }
@@ -1375,6 +1456,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     }
   }
 
+  /**
+   * @param $elementName
+   */
   function removeFileRequiredRules($elementName) {
     $this->_required = array_diff($this->_required, array($elementName));
     if (isset($this->_rules[$elementName])) {
index edc190304a6a4875945e95375d2cd1cfafebc574..884731caee394821d3e656bf581ecbf2226d4fa5 100644 (file)
  * Convenience class for PHP-Gettext compatibility.
  */
 class CRM_Core_I18n_NativeGettext {
+  /**
+   * @param $string
+   *
+   * @return string
+   */
   function translate($string) {
     return gettext($string);
   }
@@ -53,6 +58,13 @@ class CRM_Core_I18n_NativeGettext {
     }
   }
 
+  /**
+   * @param $text
+   * @param $plural
+   * @param $count
+   *
+   * @return string
+   */
   function ngettext($text, $plural, $count) {
     return ngettext($text, $plural, $count);
   }
index 7d7bc3086c523681b5272f64173bbe85bd81a1a2..3c5ba2a1943910e495db4db24c53e89b944a2016 100644 (file)
  */
 class CRM_Core_I18n_PseudoConstant {
 
+  /**
+   * @param $short
+   *
+   * @return mixed
+   */
   static function longForShort($short) {
     $longForShortMapping = self::longForShortMapping();
     return $longForShortMapping[$short];
   }
 
+  /**
+   * @return array
+   */
   static function &longForShortMapping() {
     static $longForShortMapping = NULL;
     if ($longForShortMapping === NULL) {
@@ -61,6 +69,11 @@ class CRM_Core_I18n_PseudoConstant {
     return $longForShortMapping;
   }
 
+  /**
+   * @param $long
+   *
+   * @return string
+   */
   static function shortForLong($long) {
     return substr($long, 0, 2);
   }
index 8617953a3d720b78f50bb3b035977621a432a0c6..685ca6d9bb38c7f33a6264a03055f4ace6aec31b 100644 (file)
@@ -371,6 +371,12 @@ class CRM_Core_I18n_Schema {
     return $query;
   }
 
+  /**
+   * @param null $version
+   * @param bool $force
+   *
+   * @return array
+   */
   static function schemaStructureTables($version = NULL, $force = FALSE) {
     static $_tables = NULL;
     if ($_tables === NULL || $force) {
@@ -390,6 +396,11 @@ class CRM_Core_I18n_Schema {
     return $_tables;
   }
 
+  /**
+   * @param $version
+   *
+   * @return mixed
+   */
   static function getLatestSchema($version) {
     // remove any .upgrade sub-str from version. Makes it easy to do version_compare & give right result
     $version = str_ireplace(".upgrade", "", $version);
@@ -480,6 +491,10 @@ class CRM_Core_I18n_Schema {
     return "CREATE OR REPLACE VIEW {$table}_{$locale} AS SELECT " . implode(', ', $cols) . " FROM {$table}";
   }
 
+  /**
+   * @param $info
+   * @param null $tableName
+   */
   static function triggerInfo(&$info, $tableName = NULL) {
     // get the current supported locales
     $domain = new CRM_Core_DAO_Domain();
index 109d5dcdb62b5df35e55cf4625e837449a651049..ec4a0c7e8c77ae02dd7647b9f3c90aaf67f8b6fe 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_2_2_0 {
+  /**
+   * @return mixed
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -41,6 +44,9 @@ class CRM_Core_I18n_SchemaStructure_2_2_0 {
     return $result;
   }
 
+  /**
+   * @return mixed
+   */
   static  function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -49,6 +55,9 @@ class CRM_Core_I18n_SchemaStructure_2_2_0 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index 6c1cdf6ca4a336a099ea51394280023a05169522..a3f1b9f4d02d222b0948e57f36a7ec82391394aa 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_0_alpha1 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -161,6 +164,9 @@ class CRM_Core_I18n_SchemaStructure_3_0_alpha1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -231,6 +237,9 @@ class CRM_Core_I18n_SchemaStructure_3_0_alpha1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static  function &tables() {
     static $result = NULL;
     if (!$result) {
index 8dff958539b81c5ed243ef6acf19a08148363bd8..ddde1d66df0c27d6f5657452c56882dd8a033404 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_0_beta1 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -169,6 +172,9 @@ class CRM_Core_I18n_SchemaStructure_3_0_beta1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -247,6 +253,9 @@ class CRM_Core_I18n_SchemaStructure_3_0_beta1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index 4c5188a20dd339c68341e1ad008d73f57b1f4b7b..55ffa65c3cbdad59b8de32d6df8cd675397ecbd7 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_0_beta4 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -182,6 +185,9 @@ class CRM_Core_I18n_SchemaStructure_3_0_beta4 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -260,6 +266,9 @@ class CRM_Core_I18n_SchemaStructure_3_0_beta4 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index 4e2a04d22b842de1176172568bdda6f1325f778a..b5117ceb12b48e11e11ae59e685f9959f20e951d 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_1_alpha1 {
+  /**
+   * @return array
+   */
   static  function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -186,6 +189,9 @@ class CRM_Core_I18n_SchemaStructure_3_1_alpha1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -264,6 +270,9 @@ class CRM_Core_I18n_SchemaStructure_3_1_alpha1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index a97235b81fa0e5ef1e25de61b9739818fb2fcd56..91741756442d009d46f63e162fb51d60cf9ab46a 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_1_beta2 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -189,6 +192,9 @@ class CRM_Core_I18n_SchemaStructure_3_1_beta2 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -267,6 +273,9 @@ class CRM_Core_I18n_SchemaStructure_3_1_beta2 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index 2f958eb766d98107e2125a36ed1419542e46af5e..3171239ddfc2651d57f892d12c6c6b255ae667db 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_2_beta4 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -190,6 +193,9 @@ class CRM_Core_I18n_SchemaStructure_3_2_beta4 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -268,6 +274,9 @@ class CRM_Core_I18n_SchemaStructure_3_2_beta4 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index 6d3d713b046cbfd234777aca3e91b1a3ccc115e9..28e88948749fd6195023d56041832fc2e3056a4b 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_3_beta1 {
+  /**
+   * @return array
+   */
   static
   function &columns() {
     static $result = NULL;
@@ -198,6 +201,10 @@ class CRM_Core_I18n_SchemaStructure_3_3_beta1 {
     }
     return $result;
   }
+
+  /**
+   * @return array
+   */
   static
   function &indices() {
     static $result = NULL;
@@ -276,6 +283,10 @@ class CRM_Core_I18n_SchemaStructure_3_3_beta1 {
     }
     return $result;
   }
+
+  /**
+   * @return array
+   */
   static
   function &tables() {
     static $result = NULL;
index e717c74d5aa2381482672a30238f0009d79646db..ef9a99fb732b6c469ba3bc01880ea2c27403138a 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_4_0 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -165,6 +168,9 @@ class CRM_Core_I18n_SchemaStructure_3_4_0 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -203,6 +209,9 @@ class CRM_Core_I18n_SchemaStructure_3_4_0 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index d88acb5a9da15b78674832d6aa5498c21e0616be..9424b7f18ad6c941f50533e13ed3d4363b866c4c 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_4_beta2 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -198,6 +201,9 @@ class CRM_Core_I18n_SchemaStructure_3_4_beta2 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -276,6 +282,9 @@ class CRM_Core_I18n_SchemaStructure_3_4_beta2 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index bcb31f5317e3b4085fafd98a98ac82186a8f053e..28bba0ee38a66f5a6d1981bed7bd1e72b02260c5 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_3_4_beta3 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -165,6 +168,9 @@ class CRM_Core_I18n_SchemaStructure_3_4_beta3 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -203,6 +209,9 @@ class CRM_Core_I18n_SchemaStructure_3_4_beta3 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index d391d098086d19cb23abfa44eff72411d2d3d7b2..eb4d3f3a854a63bff0aa5ac33435179271c343d0 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_4_1_0 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -171,6 +174,9 @@ class CRM_Core_I18n_SchemaStructure_4_1_0 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -209,6 +215,9 @@ class CRM_Core_I18n_SchemaStructure_4_1_0 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index 064539c1dc30da88a3fdd6e582c21e0873cbacac..9c1a54f5493d93fa5253cb16ad9f8b7d16fe362f 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Core_I18n_SchemaStructure_4_1_alpha1 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = NULL;
     if (!$result) {
@@ -168,6 +171,9 @@ class CRM_Core_I18n_SchemaStructure_4_1_alpha1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &indices() {
     static $result = NULL;
     if (!$result) {
@@ -206,6 +212,9 @@ class CRM_Core_I18n_SchemaStructure_4_1_alpha1 {
     return $result;
   }
 
+  /**
+   * @return array
+   */
   static function &tables() {
     static $result = NULL;
     if (!$result) {
index fb7d435d314cca334d095a7f31a1bdf02601ef28..b15c339ee8b059df87e0398d8f10272b573d6c3a 100644 (file)
@@ -33,6 +33,9 @@
  */
 class CRM_Core_I18n_SchemaStructure_4_2_alpha1
 {
+  /**
+   * @return array
+   */
   static function &columns()
   {
     static $result = null;
@@ -178,6 +181,10 @@ class CRM_Core_I18n_SchemaStructure_4_2_alpha1
         }
         return $result;
     }
+
+  /**
+   * @return array
+   */
   static function &indices()
   {
     static $result = null;
@@ -216,6 +223,10 @@ class CRM_Core_I18n_SchemaStructure_4_2_alpha1
     }
     return $result;
   }
+
+  /**
+   * @return array
+   */
   static function &tables()
   {
     static $result = null;
index 8dcb438702579d8b2602cdd923efe304911a760f..cbd03d8fbcc5316e797953af1c3ab0d899d43701 100644 (file)
@@ -33,6 +33,9 @@
  */
 class CRM_Core_I18n_SchemaStructure_4_3_1
 {
+  /**
+   * @return array
+   */
   static function &columns()
   {
     static $result = null;
@@ -183,6 +186,10 @@ class CRM_Core_I18n_SchemaStructure_4_3_1
     }
     return $result;
   }
+
+  /**
+   * @return array
+   */
   static function &indices()
   {
     static $result = null;
@@ -221,6 +228,10 @@ class CRM_Core_I18n_SchemaStructure_4_3_1
     }
     return $result;
   }
+
+  /**
+   * @return array
+   */
   static function &tables()
   {
     static $result = null;
index a11f045ab344925069110cf3f146ae249cb9637f..550ce0c01833b1ac9cd174e3e69978dcf81c0128 100644 (file)
@@ -33,6 +33,9 @@
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  */
 class CRM_Core_I18n_SchemaStructure_4_5_alpha1 {
+  /**
+   * @return array
+   */
   static function &columns() {
     static $result = null;
     if (!$result) {
@@ -182,6 +185,10 @@ class CRM_Core_I18n_SchemaStructure_4_5_alpha1 {
     }
     return $result;
   }
+
+  /**
+   * @return array
+   */
   static function &indices()
   {
     static $result = null;
@@ -220,6 +227,10 @@ class CRM_Core_I18n_SchemaStructure_4_5_alpha1 {
     }
     return $result;
   }
+
+  /**
+   * @return array
+   */
   static function &tables()
   {
     static $result = null;
index 0a3e7a58ab2c5624c8646d4616ed7b1754b24b1f..67d293a2393815184ce0c10e888be2efee5c5b66 100644 (file)
@@ -57,6 +57,9 @@ class CRM_Core_Invoke {
     }
   }
 
+  /**
+   * @param $args
+   */
   protected static function _invoke($args) {
     if ($args[0] !== 'civicrm') {
       return;
@@ -375,6 +378,12 @@ class CRM_Core_Invoke {
     $template->assign('newer_civicrm_version', $newerVersion);
   }
 
+  /**
+   * @param bool $triggerRebuild
+   * @param bool $sessionReset
+   *
+   * @throws Exception
+   */
   static function rebuildMenuAndCaches($triggerRebuild = FALSE, $sessionReset = FALSE) {
     $config = CRM_Core_Config::singleton();
     $config->clearModuleList();
index f8f0198a36cf174d52e447d1546185defd0a0496..d41b66cf57465b8ad7e419ff04ebde1ad07a413a 100644 (file)
@@ -58,6 +58,9 @@ class CRM_Core_JobManager {
    * @access public
    *
    */
+  /**
+   *
+   */
   public function __construct() {
     $config = CRM_Core_Config::singleton();
     $config->fatalErrorHandler = 'CRM_Core_JobManager_scheduledJobFatalErrorHandler';
@@ -71,6 +74,9 @@ class CRM_Core_JobManager {
    * @access private
    *
    */
+  /**
+   * @param bool $auth
+   */
   public function execute($auth = TRUE) {
 
     $this->logEntry('Starting scheduled jobs execution');
@@ -101,11 +107,18 @@ class CRM_Core_JobManager {
    */
   public function __destruct() {}
 
+  /**
+   * @param $entity
+   * @param $action
+   */
   public function executeJobByAction($entity, $action) {
     $job = $this->_getJob(NULL, $entity, $action);
     $this->executeJob($job);
   }
 
+  /**
+   * @param $id
+   */
   public function executeJobById($id) {
     $job = $this->_getJob($id);
     $this->executeJob($job);
@@ -147,6 +160,9 @@ class CRM_Core_JobManager {
    * @access private
    *
    */
+  /**
+   * @return array
+   */
   private function _getJobs() {
     $jobs = array();
     $dao = new CRM_Core_DAO_Job();
@@ -169,6 +185,14 @@ class CRM_Core_JobManager {
    * @access private
    *
    */
+  /**
+   * @param null $id
+   * @param null $entity
+   * @param null $action
+   *
+   * @return CRM_Core_ScheduledJob
+   * @throws Exception
+   */
   private function _getJob($id = NULL, $entity = NULL, $action = NULL) {
     if (is_null($id) && is_null($action)) {
       CRM_Core_Error::fatal('You need to provide either id or name to use this method');
@@ -185,6 +209,12 @@ class CRM_Core_JobManager {
     return $job;
   }
 
+  /**
+   * @param $entity
+   * @param $job
+   * @param $params
+   * @param null $source
+   */
   public function setSingleRunParams($entity, $job, $params, $source = NULL) {
     $this->_source = $source;
     $key = strtolower($entity . '_' . $job);
@@ -198,6 +228,9 @@ class CRM_Core_JobManager {
    * @access public
    *
    */
+  /**
+   * @param $message
+   */
   public function logEntry($message) {
     $domainID = CRM_Core_Config::domainID();
     $dao = new CRM_Core_DAO_JobLog();
@@ -231,6 +264,11 @@ class CRM_Core_JobManager {
     $dao->save();
   }
 
+  /**
+   * @param $apiResult
+   *
+   * @return string
+   */
   private function _apiResultToMessage($apiResult) {
     $status = $apiResult['is_error'] ? ts('Failure') : ts('Success');
     $msg    = CRM_Utils_Array::value('error_message', $apiResult, 'empty error_message!');
@@ -246,6 +284,11 @@ class CRM_Core_JobManager {
   }
 }
 
+/**
+ * @param $message
+ *
+ * @throws Exception
+ */
 function CRM_Core_JobManager_scheduledJobFatalErrorHandler($message) {
   throw new Exception("{$message['message']}: {$message['code']}");
 }
index fbe914552b97002c94b194d21ec37b2c25b069b9..351743480eff0298ae1e0f833893dd1e9c2826d3 100644 (file)
@@ -56,6 +56,9 @@ class CRM_Core_Key {
     return self::$_key;
   }
 
+  /**
+   * @return mixed|null|string
+   */
   static function sessionID() {
     if (!self::$_sessionID) {
       $session = CRM_Core_Session::singleton();
@@ -131,6 +134,11 @@ class CRM_Core_Key {
     return $key;
   }
 
+  /**
+   * @param $key
+   *
+   * @return bool
+   */
   static function valid($key) {
     // a valid key is a 32 digit hex number
     // followed by an optional _ and a number between 1 and 10000
index 405cda99de41fe5300f3c3023ebb03b34058f1b4..82d9ddb577beeeae9afa3bf1aa7cd3f0e7cb7be8 100644 (file)
@@ -74,6 +74,9 @@ class CRM_Core_Lock {
     $this->release();
   }
 
+  /**
+   * @return bool
+   */
   function acquire() {
     if (!$this->_hasLock) {
       $query = "SELECT GET_LOCK( %1, %2 )";
@@ -88,6 +91,9 @@ class CRM_Core_Lock {
     return $this->_hasLock;
   }
 
+  /**
+   * @return null|string
+   */
   function release() {
     if ($this->_hasLock) {
       $this->_hasLock = FALSE;
@@ -98,12 +104,18 @@ class CRM_Core_Lock {
     }
   }
 
+  /**
+   * @return null|string
+   */
   function isFree() {
     $query = "SELECT IS_FREE_LOCK( %1 )";
     $params = array(1 => array($this->_name, 'String'));
     return CRM_Core_DAO::singleValueQuery($query, $params);
   }
 
+  /**
+   * @return bool
+   */
   function isAcquired() {
     return $this->_hasLock;
   }
index 75e0c26ec659fb1882580ae6d24c2077846f4d81..6d110fb95010d6f92d1d8d5d85f96ab5aecb5a79 100644 (file)
@@ -257,6 +257,11 @@ class CRM_Core_ManagedEntities {
     return FALSE;
   }
 
+  /**
+   * @param $declarations
+   *
+   * @return mixed
+   */
   protected static function cleanDeclarations($declarations) {
     foreach ($declarations as $name => &$declare) {
       if (!array_key_exists('name', $declare)) {
@@ -266,6 +271,12 @@ class CRM_Core_ManagedEntities {
     return $declarations;
   }
 
+  /**
+   * @param $params
+   * @param $result
+   *
+   * @throws Exception
+   */
   protected function onApiError($params, $result) {
     CRM_Core_Error::debug_var('ManagedEntities_failed', array(
       'params' => $params,
index b629e27e5ed02d90f0e636960ddcb1a61d95eeb8..79e9dd1ed8c0b89ac53997acf406b879c6136bc5 100644 (file)
@@ -68,6 +68,9 @@ class CRM_Core_Menu {
   static $_menuCache = NULL;
   CONST MENU_ITEM = 1;
 
+  /**
+   * @return array
+   */
   static function &xmlItems() {
     if (!self::$_items) {
       $config = CRM_Core_Config::singleton();
@@ -95,6 +98,12 @@ class CRM_Core_Menu {
     return self::$_items;
   }
 
+  /**
+   * @param $name
+   * @param $menu
+   *
+   * @throws Exception
+   */
   static function read($name, &$menu) {
 
     $config = CRM_Core_Config::singleton();
@@ -156,6 +165,11 @@ class CRM_Core_Menu {
     return self::xmlItems();
   }
 
+  /**
+   * @param $values
+   *
+   * @return bool
+   */
   static function isArrayTrue(&$values) {
     foreach ($values as $name => $value) {
       if (!$value) {
@@ -165,6 +179,12 @@ class CRM_Core_Menu {
     return TRUE;
   }
 
+  /**
+   * @param $menu
+   * @param $path
+   *
+   * @throws Exception
+   */
   static function fillMenuValues(&$menu, $path) {
     $fieldsToPropagate = array(
       'access_callback',
@@ -234,6 +254,9 @@ class CRM_Core_Menu {
     self::buildAdminLinks($menu);
   }
 
+  /**
+   * @param bool $truncate
+   */
   static function store($truncate = TRUE) {
     // first clean up the db
     if ($truncate) {
@@ -271,6 +294,9 @@ class CRM_Core_Menu {
     }
   }
 
+  /**
+   * @param $menu
+   */
   static function buildAdminLinks(&$menu) {
     $values = array();
 
@@ -310,6 +336,12 @@ class CRM_Core_Menu {
     $menu['admin'] = array('breadcrumb' => $values);
   }
 
+  /**
+   * @param bool $all
+   *
+   * @return mixed
+   * @throws Exception
+   */
   static function &getNavigation($all = FALSE) {
     CRM_Core_Error::fatal();
 
@@ -416,6 +448,9 @@ class CRM_Core_Menu {
     return $values;
   }
 
+  /**
+   * @return null
+   */
   static function &getAdminLinks() {
     $links = self::get('admin');
 
@@ -479,12 +514,22 @@ class CRM_Core_Menu {
     return $crumbs;
   }
 
+  /**
+   * @param $menu
+   * @param $path
+   */
   static function buildReturnUrl(&$menu, $path) {
     if (!isset($menu[$path]['return_url'])) {
       list($menu[$path]['return_url'], $menu[$path]['return_url_args']) = self::getReturnUrl($menu, $path);
     }
   }
 
+  /**
+   * @param $menu
+   * @param $path
+   *
+   * @return array
+   */
   static function getReturnUrl(&$menu, $path) {
     if (!isset($menu[$path]['return_url'])) {
       $pathElements = explode('/', $path);
@@ -509,6 +554,10 @@ class CRM_Core_Menu {
     }
   }
 
+  /**
+   * @param $menu
+   * @param $path
+   */
   static function fillComponentIds(&$menu, $path) {
     static $cache = array();
 
@@ -542,6 +591,11 @@ class CRM_Core_Menu {
     }
   }
 
+  /**
+   * @param $path
+   *
+   * @return null
+   */
   static function get($path) {
     // return null if menu rebuild
     $config = CRM_Core_Config::singleton();
@@ -644,6 +698,11 @@ UNION (
     return $menuPath;
   }
 
+  /**
+   * @param $pathArgs
+   *
+   * @return mixed
+   */
   static function getArrayForPathArgs($pathArgs) {
     if (!is_string($pathArgs)) {
       return;
index 699173699962b0e19cf18b784123a7b03668d9cf..58a848c29c05c10f9564a3e5aa0757dc76d81696 100644 (file)
@@ -47,6 +47,10 @@ class CRM_Core_Module {
    */
   public $is_active;
 
+  /**
+   * @param $name
+   * @param $is_active
+   */
   public function __construct($name, $is_active) {
     $this->name = $name;
     $this->is_active = $is_active;
index 6049e10b46f0dc39d1af087fcc096f9198d834f3..b9560ea7e70a50ae71d5c6193ced9619452f50cb 100644 (file)
@@ -46,6 +46,15 @@ class CRM_Core_OptionGroup {
     'grant_type',
   );
 
+  /**
+   * @param $dao
+   * @param bool $flip
+   * @param bool $grouping
+   * @param bool $localize
+   * @param string $valueColumnName
+   *
+   * @return array
+   */
   static function &valuesCommon(
     $dao, $flip = FALSE, $grouping = FALSE,
     $localize = FALSE, $valueColumnName = 'label'
@@ -172,6 +181,9 @@ WHERE  v.option_group_id = g.id
     unset(self::$_cache[$cacheKey]);
   }
 
+  /**
+   * @return string
+   */
   protected static function createCacheKey() {
     $cacheKey = "CRM_OG_" . serialize(func_get_args());
     return $cacheKey;
@@ -305,6 +317,13 @@ WHERE  v.option_group_id = g.id
     }
   }
 
+  /**
+   * @param $groupName
+   * @param $value
+   * @param bool $onlyActiveValue
+   *
+   * @return null
+   */
   static function getLabel($groupName, $value, $onlyActiveValue = TRUE) {
     if (empty($groupName) ||
       empty($value)
@@ -334,6 +353,15 @@ WHERE  v.option_group_id = g.id
     return NULL;
   }
 
+  /**
+   * @param $groupName
+   * @param $label
+   * @param string $labelField
+   * @param string $labelType
+   * @param string $valueField
+   *
+   * @return null
+   */
   static function getValue($groupName,
     $label,
     $labelField = 'label',
@@ -458,6 +486,12 @@ WHERE  v.option_group_id = g.id
     return $group->id;
   }
 
+  /**
+   * @param $groupName
+   * @param $values
+   * @param bool $flip
+   * @param string $field
+   */
   static function getAssoc($groupName, &$values, $flip = FALSE, $field = 'name') {
     $query = "
 SELECT v.id as amount_id, v.value, v.label, v.name, v.description, v.weight
@@ -498,6 +532,10 @@ ORDER BY v.weight
     }
   }
 
+  /**
+   * @param $groupName
+   * @param string $operator
+   */
   static function deleteAssoc($groupName, $operator = "=") {
     $query = "
 DELETE g, v
@@ -511,6 +549,12 @@ DELETE g, v
     $dao = CRM_Core_DAO::executeQuery($query, $params);
   }
 
+  /**
+   * @param $groupName
+   * @param $value
+   *
+   * @return null|string
+   */
   static function optionLabel($groupName, $value) {
     $query = "
 SELECT v.label
@@ -525,6 +569,15 @@ SELECT v.label
     return CRM_Core_DAO::singleValueQuery($query, $params);
   }
 
+  /**
+   * @param $groupName
+   * @param $fieldValue
+   * @param string $field
+   * @param string $fieldType
+   * @param bool $active
+   *
+   * @return array
+   */
   static function getRowValues($groupName, $fieldValue, $field = 'name',
     $fieldType = 'String', $active = TRUE
   ) {
@@ -566,6 +619,10 @@ WHERE  v.option_group_id = g.id
    * which is part of the cache key
    * will do a couple of variations & aspire to someone cleaning it up later
    */
+  /**
+   * @param $name
+   * @param array $params
+   */
   static function flush($name, $params = array()){
     $defaults = array(
       'flip' => FALSE,
index eda6b82bb08ffda86508cde4ff8fcc58baff5ba2..291c7d6297c437ab19086144b540f92bd20ad435 100644 (file)
@@ -416,14 +416,26 @@ class CRM_Core_Page {
     return $this->_print;
   }
 
+  /**
+   * @return CRM_Core_Smarty
+   */
   static function &getTemplate() {
     return self::$_template;
   }
 
+  /**
+   * @param $name
+   *
+   * @return null
+   */
   function getVar($name) {
     return isset($this->$name) ? $this->$name : NULL;
   }
 
+  /**
+   * @param $name
+   * @param $value
+   */
   function setVar($name, $value) {
     $this->$name = $value;
   }
index 71a60b33808637e2ac4ce2b0f26b12608d62b9a9..e36d879a84ddee47fc5d78a90e8d1f305ce9161f 100644 (file)
@@ -24,6 +24,9 @@ class CRM_Core_Page_Angular extends CRM_Core_Page {
     return parent::run();
   }
 
+  /**
+   * @param CRM_Core_Resources $res
+   */
   public function registerResources(CRM_Core_Resources $res) {
     $modules = self::getAngularModules();
 
index a43791731b0011e0ce7e0d89fa27498b2e1dc30f..7ca6a073a8cb476f0945fc2c17a5c4da28c8a5c6 100644 (file)
@@ -185,6 +185,9 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
     return parent::run();
   }
 
+  /**
+   * @return string
+   */
   function superRun() {
     return parent::run();
   }
index 2256fbae415c8561dcb085a28df1ad4e97a2d0c6..91d0919ab63270eeb57717228ada9a01d9308216 100644 (file)
@@ -193,6 +193,11 @@ abstract class CRM_Core_Payment {
    */
   abstract function checkConfig();
 
+  /**
+   * @param $paymentProcessor
+   *
+   * @return bool
+   */
   static function paypalRedirect(&$paymentProcessor) {
     if (!$paymentProcessor) {
       return FALSE;
@@ -337,6 +342,13 @@ abstract class CRM_Core_Payment {
     return method_exists(CRM_Utils_System::getClassName($this), $method);
   }
 
+  /**
+   * @param null $entityID
+   * @param null $entity
+   * @param string $action
+   *
+   * @return string
+   */
   function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') {
     if ($action == 'cancel') {
       $url = 'civicrm/contribute/unsubscribe';
index d3f158ab9bbeb97d4f3f741fc5ad23c44187ce7f..2ed0969948d90b8529e1b406bfdd50f0f14cbad6 100644 (file)
@@ -201,6 +201,9 @@ class CRM_Core_Permission {
     return $config->userPermissionClass->group($groupType, $excludeHidden);
   }
 
+  /**
+   * @return bool
+   */
   public static function customGroupAdmin() {
     $admin = FALSE;
 
@@ -224,6 +227,12 @@ class CRM_Core_Permission {
     return FALSE;
   }
 
+  /**
+   * @param int $type
+   * @param bool $reset
+   *
+   * @return array
+   */
   public static function customGroup($type = CRM_Core_Permission::VIEW, $reset = FALSE) {
     $customGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id',
       array('fresh' => $reset));
@@ -238,6 +247,13 @@ class CRM_Core_Permission {
     return CRM_ACL_API::group($type, NULL, 'civicrm_custom_group', $customGroups, $defaultGroups);
   }
 
+  /**
+   * @param int $type
+   * @param null $prefix
+   * @param bool $reset
+   *
+   * @return string
+   */
   static function customGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $reset = FALSE) {
     if (self::customGroupAdmin()) {
       return ' ( 1 ) ';
@@ -252,6 +268,12 @@ class CRM_Core_Permission {
     }
   }
 
+  /**
+   * @param $gid
+   * @param int $type
+   *
+   * @return bool
+   */
   public static function ufGroupValid($gid, $type = CRM_Core_Permission::VIEW) {
     if (empty($gid)) {
       return TRUE;
@@ -261,6 +283,11 @@ class CRM_Core_Permission {
     return in_array($gid, $groups) ? TRUE : FALSE;
   }
 
+  /**
+   * @param int $type
+   *
+   * @return array
+   */
   public static function ufGroup($type = CRM_Core_Permission::VIEW) {
     $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
 
@@ -300,6 +327,13 @@ class CRM_Core_Permission {
     return CRM_ACL_API::group($type, NULL, 'civicrm_uf_group', $ufGroups);
   }
 
+  /**
+   * @param int $type
+   * @param null $prefix
+   * @param bool $returnUFGroupIds
+   *
+   * @return array|string
+   */
   static function ufGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $returnUFGroupIds = FALSE) {
     $groups = self::ufGroup($type);
     if ($returnUFGroupIds) {
@@ -313,6 +347,13 @@ class CRM_Core_Permission {
     }
   }
 
+  /**
+   * @param int $type
+   * @param null $eventID
+   * @param string $context
+   *
+   * @return array|null
+   */
   public static function event($type = CRM_Core_Permission::VIEW, $eventID = NULL, $context = '') {
     if(!empty($context)) {
       if(CRM_Core_Permission::check($context)) {
@@ -343,6 +384,12 @@ class CRM_Core_Permission {
     return NULL;
   }
 
+  /**
+   * @param int $type
+   * @param null $prefix
+   *
+   * @return string
+   */
   static function eventClause($type = CRM_Core_Permission::VIEW, $prefix = NULL) {
     $events = self::event($type);
     if (empty($events)) {
@@ -353,6 +400,12 @@ class CRM_Core_Permission {
     }
   }
 
+  /**
+   * @param $module
+   * @param bool $checkPermission
+   *
+   * @return bool
+   */
   static function access($module, $checkPermission = TRUE) {
     $config = CRM_Core_Config::singleton();
 
@@ -408,6 +461,12 @@ class CRM_Core_Permission {
     }
   }
 
+  /**
+   * @param $args
+   * @param string $op
+   *
+   * @return bool
+   */
   static function checkMenu(&$args, $op = 'and') {
     if (!is_array($args)) {
       return $args;
@@ -424,6 +483,12 @@ class CRM_Core_Permission {
     return ($op == 'or') ? FALSE : TRUE;
   }
 
+  /**
+   * @param $item
+   *
+   * @return bool|mixed
+   * @throws Exception
+   */
   static function checkMenuItem(&$item) {
     if (!array_key_exists('access_callback', $item)) {
       CRM_Core_Error::backtrace();
@@ -473,6 +538,11 @@ class CRM_Core_Permission {
     }
   }
 
+  /**
+   * @param bool $all
+   *
+   * @return array
+   */
   static function &basicPermissions($all = FALSE) {
     static $permissions = NULL;
 
@@ -510,6 +580,9 @@ class CRM_Core_Permission {
     return $permissions;
   }
 
+  /**
+   * @return array
+   */
   static function getAnonymousPermissionsWarnings() {
     static $permissions = array();
     if (empty($permissions)) {
@@ -527,10 +600,18 @@ class CRM_Core_Permission {
     return $permissions;
   }
 
+  /**
+   * @param $anonymous_perms
+   *
+   * @return array
+   */
   static function validateForPermissionWarnings($anonymous_perms) {
     return array_intersect($anonymous_perms, self::getAnonymousPermissionsWarnings());
   }
 
+  /**
+   * @return array
+   */
   static function getCorePermissions() {
     $prefix = ts('CiviCRM') . ': ';
     $permissions = array(
@@ -681,6 +762,9 @@ class CRM_Core_Permission {
     return $config->userRoleClass->roleEmails($roleName);
   }
 
+  /**
+   * @return bool
+   */
   static function isMultisiteEnabled() {
     return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
       'is_enabled'
index d65374b2c5aa045953bb6c895da510abf9cab53a..4991d1349990b63fa6b6485b61c3e287dd323a30 100644 (file)
@@ -218,6 +218,11 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base {
     return NULL;
   }
 
+  /**
+   * @param $uids
+   *
+   * @return string
+   */
   function getContactEmails($uids) {
     if (empty($uids)) {
       return '';
index 7d333fa87fc817291eafe8677d0b3544bf5de4e5..a93e07f59e0265a9cbc897ee223c4f9e8ab9c925 100644 (file)
@@ -1549,6 +1549,12 @@ WHERE  id = %1";
     return self::$visibility[$column];
   }
 
+  /**
+   * @param $countryID
+   * @param string $field
+   *
+   * @return array
+   */
   public static function &stateProvinceForCountry($countryID, $field = 'name') {
     static $_cache = NULL;
 
@@ -1598,6 +1604,11 @@ ORDER BY name";
     return $result;
   }
 
+  /**
+   * @param $stateID
+   *
+   * @return array
+   */
   public static function &countyForState($stateID) {
     if (is_array($stateID)) {
       $states = implode(", ", $stateID);
index 15d90e4e39f690889a458e83b6507b29974a0be8..ba5945858e17fe7d1fb594404225a3cac9cdd02f 100644 (file)
@@ -129,6 +129,12 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
     $page->controller->_actions['upload']->realPerform($page, $actionName);
   }
 
+  /**
+   * @param $page
+   * @param $actionName
+   *
+   * @return mixed
+   */
   function realPerform(&$page, $actionName) {
     $pageName = $page->getAttribute('name');
     $data = &$page->controller->container();
index f0c897e268e5ec5b79b66869b63f9120f8e0b69d..0b13ef5f5b551e5f234948667e6c88f20e5a806f 100644 (file)
@@ -12,6 +12,13 @@ class CRM_Core_Reference_Basic implements CRM_Core_Reference_Interface {
   protected $targetTable;
   protected $targetKey;
 
+  /**
+   * @param $refTable
+   * @param $refKey
+   * @param null $targetTable
+   * @param string $targetKey
+   * @param null $refTypeColumn
+   */
   function __construct($refTable, $refKey, $targetTable = NULL, $targetKey = 'id', $refTypeColumn = NULL) {
     $this->refTable = $refTable;
     $this->refKey = $refKey;
@@ -20,30 +27,55 @@ class CRM_Core_Reference_Basic implements CRM_Core_Reference_Interface {
     $this->refTypeColumn = $refTypeColumn;
   }
 
+  /**
+   * @return mixed
+   */
   function getReferenceTable() {
     return $this->refTable;
   }
 
+  /**
+   * @return mixed
+   */
   function getReferenceKey() {
     return $this->refKey;
   }
 
+  /**
+   * @return null
+   */
   function getTypeColumn() {
     return $this->refTypeColumn;
   }
 
+  /**
+   * @return null
+   */
   function getTargetTable() {
     return $this->targetTable;
   }
 
+  /**
+   * @return string
+   */
   function getTargetKey() {
     return $this->targetKey;
   }
 
+  /**
+   * @param string $tableName
+   *
+   * @return bool
+   */
   public function matchesTargetTable($tableName) {
     return ($this->getTargetTable() === $tableName);
   }
 
+  /**
+   * @param CRM_Core_DAO $targetDao
+   *
+   * @return Object
+   */
   public function findReferences($targetDao) {
     $targetColumn = $this->getTargetKey();
     $params = array(
@@ -60,6 +92,11 @@ EOS;
     return $result;
   }
 
+  /**
+   * @param CRM_Core_DAO $targetDao
+   *
+   * @return array
+   */
   public function getReferenceCount($targetDao) {
     $targetColumn = $this->getTargetKey();
     $params = array(
index 85c5d00f334e8f646a86dd2c070a0869de1ae94d..c33477eb3d1787ffa1fa25067c170977704b62c3 100644 (file)
@@ -7,6 +7,11 @@
  */
 class CRM_Core_Reference_Dynamic extends CRM_Core_Reference_Basic {
 
+  /**
+   * @param string $tableName
+   *
+   * @return bool
+   */
   public function matchesTargetTable($tableName) {
     return TRUE;
   }
@@ -41,6 +46,11 @@ EOS;
     return $result;
   }
 
+  /**
+   * @param CRM_Core_DAO $targetDao
+   *
+   * @return array
+   */
   public function getReferenceCount($targetDao) {
     $targetColumn = $this->getTargetKey();
     $params = array(
index 6c983ba337f5252b62cbb19e21ce6ec180819318..7229af33d775db9440cf9973c33a2b8d0eb53907 100644 (file)
@@ -14,11 +14,24 @@ class CRM_Core_Reference_OptionValue extends CRM_Core_Reference_Basic {
    */
   protected $targetOptionGroupId;
 
+  /**
+   * @param $refTable
+   * @param $refKey
+   * @param null $targetTable
+   * @param string $targetKey
+   * @param null $optionGroupName
+   */
   function __construct($refTable, $refKey, $targetTable = NULL, $targetKey = 'id', $optionGroupName) {
     parent::__construct($refTable, $refKey, $targetTable, $targetKey, NULL);
     $this->targetOptionGroupName = $optionGroupName;
   }
 
+  /**
+   * @param CRM_Core_DAO $targetDao
+   *
+   * @return null|Object
+   * @throws CRM_Core_Exception
+   */
   public function findReferences($targetDao) {
     if (! ($targetDao instanceof CRM_Core_DAO_OptionValue)) {
       throw new CRM_Core_Exception("Mismatched reference: expected OptionValue but received " . get_class($targetDao));
@@ -30,6 +43,12 @@ class CRM_Core_Reference_OptionValue extends CRM_Core_Reference_Basic {
     }
   }
 
+  /**
+   * @param CRM_Core_DAO $targetDao
+   *
+   * @return array|null
+   * @throws CRM_Core_Exception
+   */
   public function getReferenceCount($targetDao) {
     if (! ($targetDao instanceof CRM_Core_DAO_OptionValue)) {
       throw new CRM_Core_Exception("Mismatched reference: expected OptionValue but received " . get_class($targetDao));
@@ -41,10 +60,13 @@ class CRM_Core_Reference_OptionValue extends CRM_Core_Reference_Basic {
     }
   }
 
+  /**
+   * @return int|NULL
+   */
   public function getTargetOptionGroupId() {
     if ($this->targetOptionGroupId === NULL) {
       $this->targetOptionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $this->targetOptionGroupName, 'id', 'name');
     }
     return $this->targetOptionGroupId;
   }
-}
\ No newline at end of file
+}
index 5cde68767ef2bb9856f582ec6183c9f949ef5cbb..63953d104b95b1ce7b86f5f2e58c275475e1316d 100644 (file)
@@ -41,6 +41,9 @@ class CRM_Core_Region {
    */
   var $_isSorted;
 
+  /**
+   * @param $name
+   */
   public function __construct($name) {
     // Templates injected into regions should normally be file names, but sometimes inline notation is handy.
     require_once 'CRM/Core/Smarty/resources/String.php';
@@ -122,11 +125,20 @@ class CRM_Core_Region {
     return $snippet;
   }
 
+  /**
+   * @param $name
+   * @param $snippet
+   */
   public function update($name, $snippet) {
     $this->_snippets[$name] = array_merge($this->_snippets[$name], $snippet);
     $this->_isSorted = FALSE;
   }
 
+  /**
+   * @param $name
+   *
+   * @return mixed
+   */
   public function &get($name) {
     return @$this->_snippets[$name];
   }
@@ -203,6 +215,12 @@ class CRM_Core_Region {
     return $html;
   }
 
+  /**
+   * @param $a
+   * @param $b
+   *
+   * @return int
+   */
   static function _cmpSnippet($a, $b) {
     if ($a['weight'] < $b['weight']) return -1;
     if ($a['weight'] > $b['weight']) return 1;
index 3aeefb50f8b23c92c8b1e22249d9a3c5441a80d7..13718cbe0c2514b04592d076cbdd3b87f7a3b3d1 100644 (file)
@@ -151,6 +151,13 @@ class CRM_Core_Report_Excel {
     }
   }
 
+  /**
+   * @param $fileName
+   * @param $header
+   * @param $rows
+   * @param null $titleHeader
+   * @param bool $outputHeader
+   */
   function writeHTMLFile($fileName, &$header, &$rows, $titleHeader = NULL, $outputHeader = TRUE) {
     if ($outputHeader) {
       CRM_Utils_System::download(CRM_Utils_String::munge($fileName),
index 4661484d287dc9e5d3b394297d9bb6e4b5dfb82b..8d7f8adbd771ab08468c9c46289c186d3e723db1 100644 (file)
@@ -417,10 +417,16 @@ class CRM_Core_Resources {
     return $this->extMapper->keyToUrl($ext) . '/' . $file;
   }
 
+  /**
+   * @return string
+   */
   public function getCacheCode() {
     return $this->cacheCode;
   }
 
+  /**
+   * @param $value
+   */
   public function setCacheCode($value) {
     $this->cacheCode = $value;
     if ($this->cacheCodeKey) {
index 149bd126e100763a38858eccda52fff097c45103..80f8ecc9999b62266b8698af1e29b08ff449b513 100644 (file)
@@ -52,6 +52,9 @@ class CRM_Core_ScheduledJob {
      *
      */
 
+  /**
+   * @param $params
+   */
   public function __construct($params) {
     foreach ($params as $name => $param) {
       $this->$name = $param;
@@ -81,6 +84,9 @@ class CRM_Core_ScheduledJob {
     }
   }
 
+  /**
+   * @param null $date
+   */
   public function saveLastRun($date = NULL) {
     $dao           = new CRM_Core_DAO_Job();
     $dao->id       = $this->id;
@@ -88,6 +94,9 @@ class CRM_Core_ScheduledJob {
     $dao->save();
   }
 
+  /**
+   * @return bool
+   */
   public function needsRunning() {
     // run if it was never run
     if (empty($this->last_run)) {
index 78a1caf4a495f5efff9911afeba1b955bf97e8ac..212b0867e9d5a3e30440cdb808f857832036d9bc 100644 (file)
@@ -168,14 +168,23 @@ class CRM_Core_Selector_Base {
     return NULL;
   }
 
+  /**
+   * @return null
+   */
   public function getSummary() {
     return NULL;
   }
 
+  /**
+   * @param $key
+   */
   public function setKey($key) {
     $this->_key = $key;
   }
 
+  /**
+   * @return string
+   */
   public function getKey() {
     return $this->_key;
   }
index 2f00bb4c4d8c8f5382eb9c51c39c838661cad982..0e1bbaa2ac7fec075cb345107805eece5299c897 100644 (file)
@@ -420,6 +420,9 @@ class CRM_Core_Selector_Controller {
     return $this->_object->getQill();
   }
 
+  /**
+   * @return mixed
+   */
   public function getSummary() {
     return $this->_object->getSummary();
   }
@@ -531,10 +534,16 @@ class CRM_Core_Selector_Controller {
     return $this->_print;
   }
 
+  /**
+   * @param $value
+   */
   function setDynamicAction($value) {
     $this->_dynamicAction = $value;
   }
 
+  /**
+   * @return bool
+   */
   function getDynamicAction() {
     return $this->_dynamicAction;
   }
index a688685e195304b7f178c9717a821037a0a138bf..24f53be63f093c779df17d17550c100963b7a090 100644 (file)
@@ -524,6 +524,9 @@ class CRM_Core_Session {
     }
   }
 
+  /**
+   * @param $names
+   */
   static function registerAndRetrieveSessionObjects($names) {
     if (!is_array($names)) {
       $names = array($names);
@@ -539,6 +542,9 @@ class CRM_Core_Session {
     CRM_Core_BAO_Cache::restoreSessionFromCache($names);
   }
 
+  /**
+   * @param bool $reset
+   */
   static function storeSessionObjects($reset = TRUE) {
     if (empty(self::$_managedNames)) {
       return;
@@ -563,6 +569,9 @@ class CRM_Core_Session {
     return $session->get('userID');
   }
 
+  /**
+   * @return bool
+   */
   function isEmpty() {
     // check if session is empty, if so we dont cache
     // stuff that we can get away with
index 0da5594db86f1089de2dc7934c8430719417036b..1c7d6875dbbd5d18b524c7bcbb38d5c68c1536ee 100644 (file)
@@ -204,6 +204,10 @@ class CRM_Core_Smarty extends Smarty {
     return $output;
   }
 
+  /**
+   * @param $name
+   * @param $value
+   */
   function appendValue($name, $value) {
     $currentValue = $this->get_template_vars($name);
     if (!$currentValue) {
@@ -230,6 +234,9 @@ class CRM_Core_Smarty extends Smarty {
     civicrm_smarty_register_string_resource();
   }
 
+  /**
+   * @param $path
+   */
   function addTemplateDir($path) {
     if ( is_array( $this->template_dir ) ) {
       array_unshift( $this->template_dir, $path );
index 53c83dde45e8ba03134b4cc217665a7e31b8c744..2c4f648f21ed83eaca80c1068e7b2c15c8d68da0 100644 (file)
@@ -5,6 +5,11 @@
  */
 class CRM_Core_Smarty_Permissions {
   // non-static adapter for CRM_Core_Permission::check
+  /**
+   * @param $offset
+   *
+   * @return bool
+   */
   function check($offset) {
     return CRM_Core_Permission::check($offset);
   }
index ec45c53a5e3c5532c255235567c557f727166698..b37050b326d95867975dce14fff6eddc014c0e57 100644 (file)
@@ -45,6 +45,10 @@ function smarty_block_crmScope($params, $content, &$smarty, &$repeat) {
   return $content;
 }
 
+/**
+ * @param $smarty
+ * @param $frame
+ */
 function _smarty_block_crmScope_applyFrame(&$smarty, $frame) {
   foreach ($frame as $key => $value) {
     $smarty->assign($key, $value);
index 893066c357a98b8af1f6033ba4bd4c9e3af2668f..a11f9215211c8e028068dba0971654de96877378 100644 (file)
@@ -37,15 +37,32 @@ function civicrm_smarty_resource_string_get_template($tpl_name, &$tpl_source, &$
   return TRUE;
 }
 
+/**
+ * @param $tpl_name
+ * @param $tpl_timestamp
+ * @param $smarty_obj
+ *
+ * @return bool
+ */
 function civicrm_smarty_resource_string_get_timestamp($tpl_name, &$tpl_timestamp, &$smarty_obj) {
   $tpl_timestamp = time();
   return TRUE;
 }
 
+/**
+ * @param $tpl_name
+ * @param $smarty_obj
+ *
+ * @return bool
+ */
 function civicrm_smarty_resource_string_get_secure($tpl_name, &$smarty_obj) {
   return TRUE;
 }
 
+/**
+ * @param $tpl_name
+ * @param $smarty_obj
+ */
 function civicrm_smarty_resource_string_get_trusted($tpl_name, &$smarty_obj) {}
 
 function civicrm_smarty_register_string_resource() {
index 5c037548e99c2b95c7f5c924756a3e68923f5e3a..0e4d57cc3da4775aad1e88a142dcde3d747585ea 100644 (file)
@@ -357,18 +357,30 @@ class CRM_Core_StateMachine {
     return $this->_controller->getContent();
   }
 
+  /**
+   * @return mixed
+   */
   function getDestination() {
     return $this->_controller->getDestination();
   }
 
+  /**
+   * @return mixed
+   */
   function getSkipRedirection() {
     return $this->_controller->getSkipRedirection();
   }
 
+  /**
+   * @return mixed
+   */
   function fini() {
     return $this->_controller->fini();
   }
 
+  /**
+   * @return mixed
+   */
   function cancelAction() {
     return $this->_controller->cancelAction();
   }
index 4a66716de18f82522bdcc6f967a9a6f1e9ed2d71..7e050e15e6e5c2ceec916e3fa00bd91a9438ee48 100644 (file)
@@ -78,6 +78,9 @@ class CRM_Core_TableHierarchy {
     'civicrm_mailing_event_trackable_url_open' => '42',
   );
 
+  /**
+   * @return array
+   */
   static function &info() {
     //get the campaign related tables.
     CRM_Campaign_BAO_Query::info(self::$info);
index 311f047456b59112b8e9e0d381e3ca4e0b326ca1..eaf744a1ac4276541d4f2063a411610266fdb874 100644 (file)
@@ -53,6 +53,9 @@ class CRM_Core_TemporaryErrorScope {
     return new CRM_Core_TemporaryErrorScope($newFrame);
   }
 
+  /**
+   * @param $newFrame
+   */
   public function __construct($newFrame) {
     self::$oldFrames[] = self::getActive();
     self::setActive($newFrame);
index 137baba9efc17673d4c434e6aad064ed1904ebb8..63493f151eb579544577a7382439d1681b1aa47a 100644 (file)
@@ -84,6 +84,10 @@ class CRM_Core_Transaction {
    * of CRM_Core_Transaction
    */
   private $_pseudoCommitted = FALSE;
+
+  /**
+   *
+   */
   function __construct() {
     if (!self::$_dao) {
       self::$_dao = new CRM_Core_DAO();
@@ -134,6 +138,9 @@ class CRM_Core_Transaction {
     }
   }
 
+  /**
+   * @param $flag
+   */
   static public function rollbackIfFalse($flag) {
     if ($flag === FALSE) {
       self::$_doCommit = FALSE;
@@ -167,6 +174,9 @@ class CRM_Core_Transaction {
     }
   }
 
+  /**
+   * @return bool
+   */
   static public function willCommit() {
     return self::$_doCommit;
   }
@@ -195,6 +205,10 @@ class CRM_Core_Transaction {
     );
   }
 
+  /**
+   * @param $phase
+   * @param $callbacks
+   */
   static protected function invokeCallbacks($phase, $callbacks) {
     if (is_array($callbacks[$phase])) {
       foreach ($callbacks[$phase] as $cb) {