CRM/Contact add comment blocks
authorEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 01:27:01 +0000 (13:27 +1200)
committerEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 01:27:01 +0000 (13:27 +1200)
74 files changed:
CRM/Contact/BAO/Contact.php
CRM/Contact/BAO/Contact/Optimizer.php
CRM/Contact/BAO/Contact/Permission.php
CRM/Contact/BAO/Contact/Utils.php
CRM/Contact/BAO/ContactType.php
CRM/Contact/BAO/Group.php
CRM/Contact/BAO/GroupContact.php
CRM/Contact/BAO/GroupContactCache.php
CRM/Contact/BAO/GroupNesting.php
CRM/Contact/BAO/GroupNestingCache.php
CRM/Contact/BAO/GroupOrganization.php
CRM/Contact/BAO/ProximityQuery.php
CRM/Contact/BAO/Query.php
CRM/Contact/BAO/Query/Hook.php
CRM/Contact/BAO/Query/Interface.php
CRM/Contact/BAO/Relationship.php
CRM/Contact/BAO/SavedSearch.php
CRM/Contact/BAO/SearchCustom.php
CRM/Contact/BAO/SubscriptionHistory.php
CRM/Contact/Controller/Search.php
CRM/Contact/DAO/Factory.php
CRM/Contact/Form/Contact.php
CRM/Contact/Form/DedupeRules.php
CRM/Contact/Form/Domain.php
CRM/Contact/Form/Edit/Address.php
CRM/Contact/Form/Edit/Organization.php
CRM/Contact/Form/Merge.php
CRM/Contact/Form/ProfileContact.php
CRM/Contact/Form/Search.php
CRM/Contact/Form/Search/Advanced.php
CRM/Contact/Form/Search/Basic.php
CRM/Contact/Form/Search/Builder.php
CRM/Contact/Form/Search/Criteria.php
CRM/Contact/Form/Search/Custom.php
CRM/Contact/Form/Search/Custom/ActivitySearch.php
CRM/Contact/Form/Search/Custom/Base.php
CRM/Contact/Form/Search/Custom/Basic.php
CRM/Contact/Form/Search/Custom/ContribSYBNT.php
CRM/Contact/Form/Search/Custom/ContributionAggregate.php
CRM/Contact/Form/Search/Custom/DateAdded.php
CRM/Contact/Form/Search/Custom/EmployerListing.php
CRM/Contact/Form/Search/Custom/EventAggregate.php
CRM/Contact/Form/Search/Custom/FullText.php
CRM/Contact/Form/Search/Custom/Group.php
CRM/Contact/Form/Search/Custom/MultipleValues.php
CRM/Contact/Form/Search/Custom/PostalMailing.php
CRM/Contact/Form/Search/Custom/PriceSet.php
CRM/Contact/Form/Search/Custom/Proximity.php
CRM/Contact/Form/Search/Custom/RandomSegment.php
CRM/Contact/Form/Search/Custom/Sample.php
CRM/Contact/Form/Search/Custom/TagContributions.php
CRM/Contact/Form/Search/Custom/ZipCodeRange.php
CRM/Contact/Form/Task.php
CRM/Contact/Form/Task/AddToTag.php
CRM/Contact/Form/Task/AlterPreferences.php
CRM/Contact/Form/Task/EmailCommon.php
CRM/Contact/Form/Task/Label.php
CRM/Contact/Form/Task/LabelCommon.php
CRM/Contact/Form/Task/Map/Event.php
CRM/Contact/Form/Task/PDF.php
CRM/Contact/Form/Task/PDFLetterCommon.php
CRM/Contact/Form/Task/RemoveFromTag.php
CRM/Contact/Form/Task/SMSCommon.php
CRM/Contact/Form/Task/Unhold.php
CRM/Contact/Import/Field.php
CRM/Contact/Import/Form/DataSource.php
CRM/Contact/Import/ImportJob.php
CRM/Contact/Import/Importer.php
CRM/Contact/Import/Parser.php
CRM/Contact/Import/Parser/Contact.php
CRM/Contact/Selector.php
CRM/Contact/Selector/Controller.php
CRM/Contact/Selector/Custom.php
CRM/Contact/Task.php

index 4c8ffd72b16c2d504381d00fd0feadddc0677ff9..54fb90afb52ae22f30503e954068007e5902a7a6 100644 (file)
@@ -88,6 +88,16 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact {
    * @static
    */
   static $_exportableFields = NULL;
+
+  /**
+   * class constructor
+   *
+   * @access public
+   * @return \CRM_Contact_DAO_Contact
+   */
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
   }
@@ -1845,6 +1855,16 @@ ORDER BY civicrm_email.is_primary DESC";
     return $contactID;
   }
 
+  /**
+   * @param $params
+   * @param $fields
+   * @param null $contactID
+   * @param null $ufGroupId
+   * @param null $ctype
+   * @param bool $skipCustom
+   *
+   * @return array
+   */
   static function formatProfileContactParams(
     &$params,
     &$fields,
index e118efb7703db246d151a86fe06942f4adaf63f4..a05a0c17f86b1d9c1a5ce65fffa1d1a94f25386e 100644 (file)
  *
  */
 class CRM_Contact_BAO_Contact_Optimizer {
+  /**
+   * @param $newValues
+   * @param $oldValues
+   */
   static function edit( &$newValues, &$oldValues ) {
     // still need to do more work on this
     // CRM-10192
@@ -41,6 +45,10 @@ class CRM_Contact_BAO_Contact_Optimizer {
     self::website( $newValues, $oldValues );
   }
 
+  /**
+   * @param $newValues
+   * @param $oldValues
+   */
   static function website( &$newValues, &$oldValues ) {
     $oldWebsiteValues = CRM_Utils_Array::value( 'website', $oldValues );
     $newWebsiteValues = CRM_Utils_Array::value( 'website', $newValues );
@@ -100,6 +108,10 @@ class CRM_Contact_BAO_Contact_Optimizer {
     unset( $newValues['website'] );
   }
 
+  /**
+   * @param $newValues
+   * @param $oldValues
+   */
   static function email( &$newValues, &$oldValues ) {
     $oldEmailValues = CRM_Utils_Array::value( 'email', $oldValues );
     $newEmailValues = CRM_Utils_Array::value( 'email', $newValues );
index 420ef95fa453daddcc1fade823e5fd98f2e85a65..d93dea976aa61c5e2df89cb790ba7934ab4fd28a 100644 (file)
@@ -189,6 +189,12 @@ AND    $operationClause LIMIT 1";
     return (bool) CRM_Core_DAO::singleValueQuery($sql, $params);
   }
 
+  /**
+   * @param string $contactAlias
+   * @param null $contactID
+   *
+   * @return array
+   */
   static function cacheClause($contactAlias = 'contact_a', $contactID = NULL) {
     if (CRM_Core_Permission::check('view all contacts') ||
       CRM_Core_Permission::check('edit all contacts')
@@ -328,6 +334,13 @@ WHERE  (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR
   }
 
 
+  /**
+   * @param $contactID
+   * @param $form
+   * @param bool $redirect
+   *
+   * @return bool
+   */
   static function validateOnlyChecksum($contactID, &$form, $redirect = TRUE) {
     // check if this is of the format cs=XXX
     if (!CRM_Contact_BAO_Contact_Utils::validChecksum($contactID,
@@ -359,6 +372,10 @@ WHERE  (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR
     return TRUE;
   }
 
+  /**
+   * @param bool $checkSumValidationResult
+   * @param null $form
+   */
   static function initChecksumAuthSrc($checkSumValidationResult = FALSE, $form = NULL) {
     $session = CRM_Core_Session::singleton();
     if ($checkSumValidationResult && $form && CRM_Utils_Request::retrieve('cs', 'String', $form, FALSE)) {
@@ -371,6 +388,13 @@ WHERE  (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR
     }
   }
 
+  /**
+   * @param $contactID
+   * @param $form
+   * @param bool $redirect
+   *
+   * @return bool
+   */
   static function validateChecksumContact($contactID, &$form, $redirect = TRUE) {
     if (!self::allow($contactID, CRM_Core_Permission::EDIT)) {
       // check if this is of the format cs=XXX
index 0961a02580b40f51173bf47263dc9eabb2e28391..fa288fce4195ef98299eda1ed59a18bd86243387 100644 (file)
@@ -888,6 +888,11 @@ Group By  componentId";
     CRM_Contact_BAO_GroupContactCache::remove();
   }
 
+  /**
+   * @param $params
+   *
+   * @throws Exception
+   */
   public static function updateGreeting($params) {
     $contactType = $params['ct'];
     $greeting    = $params['gt'];
index ffcfcb752bd8624f7b17bbaa2824cb30a44c9380..584ba9373e1a7149788e79c247b084daff7a1f23 100644 (file)
@@ -58,6 +58,11 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType {
     return NULL;
   }
 
+  /**
+   * @param $contactType
+   *
+   * @return bool
+   */
   static function isActive($contactType) {
     $contact = self::contactTypeInfo(FALSE);
     $active = array_key_exists($contactType, $contact) ? TRUE : FALSE;
@@ -124,6 +129,12 @@ WHERE  parent_id IS NULL
     return array_keys(self::basicTypeInfo($all));
   }
 
+  /**
+   * @param bool $all
+   * @param string $key
+   *
+   * @return array
+   */
   static function basicTypePairs($all = FALSE, $key = 'name') {
     $subtypes = self::basicTypeInfo($all);
 
@@ -708,6 +719,11 @@ WHERE name = %1";
     );
   }
 
+  /**
+   * @param $typeName
+   *
+   * @return mixed
+   */
   static function getLabel($typeName) {
     $types = self::contactTypeInfo(TRUE);
 
@@ -748,6 +764,12 @@ WHERE name = %1";
     return TRUE;
   }
 
+  /**
+   * @param $contactType
+   * @param null $contactId
+   *
+   * @return bool
+   */
   static function hasCustomData($contactType, $contactId = NULL) {
     $subTypeClause = '';
 
index 18c848ada4dc4cfef254369c42b77060caec79d0..cc484a25271404f88653ae10b3efb7264d67bc7b 100644 (file)
@@ -637,6 +637,9 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
     return $clause;
   }
 
+  /**
+   * @return string
+   */
   public function __toString() {
     return $this->title;
   }
@@ -1099,6 +1102,11 @@ WHERE  id IN $groupIdString
     return $groupsReturn;
   }
 
+  /**
+   * @param $params
+   *
+   * @return null|string
+   */
   static function getGroupCount(&$params) {
     $whereClause = self::whereClause($params, FALSE);
     $query = "SELECT COUNT(*) FROM civicrm_group groups";
@@ -1246,6 +1254,12 @@ WHERE {$whereClause}";
     return $links;
   }
 
+  /**
+   * @param $whereClause
+   * @param $whereParams
+   *
+   * @return string
+   */
   function pagerAtoZ($whereClause, $whereParams) {
     $query = "
         SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name
index 5b579a14abddfeb77ff9e72c3cafbabed8f2b550..28aefe2244df27c8cb55b56887efa5f6264a4920 100644 (file)
@@ -558,6 +558,12 @@ SELECT    *
     }
   }
 
+  /**
+   * @param $contactID
+   * @param $groupID
+   *
+   * @return bool
+   */
   static function isContactInGroup($contactID, $groupID) {
     if (!CRM_Utils_Rule::positiveInteger($contactID) ||
       !CRM_Utils_Rule::positiveInteger($groupID)
index 9a82607c459b5f84fc804a525ecda5b7132911bf..e69b6815c6fad57842856250a79c6562c6984c85 100644 (file)
@@ -190,6 +190,9 @@ AND    g.refresh_date IS NULL
     }
   }
 
+  /**
+   * @param $groupID
+   */
   static function add($groupID) {
     // first delete the current cache
     self::remove($groupID);
@@ -205,6 +208,10 @@ AND    g.refresh_date IS NULL
     }
   }
 
+  /**
+   * @param $groupID
+   * @param $values
+   */
   static function store(&$groupID, &$values) {
     $processed = FALSE;
 
@@ -533,6 +540,9 @@ AND  civicrm_group_contact.group_id = $groupID ";
     $lock->release();
   }
 
+  /**
+   * @return int
+   */
   static function smartGroupCacheTimeout() {
     $config = CRM_Core_Config::singleton();
 
index b8e4cb18f0cfbc7ec2c1c1f66c018b81591d814a..dc656cd9d7a417a9ee9948edd881d3e3e76cc9bb 100644 (file)
@@ -58,6 +58,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     $this->_styleIndent = $styleIndent;
   }
 
+  /**
+   * @param $sortOrder
+   */
   function setSortOrder($sortOrder) {
     switch ($sortOrder) {
       case 'ASC':
@@ -73,10 +76,16 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     }
   }
 
+  /**
+   * @return string
+   */
   function getSortOrder() {
     return self::$_sortOrder;
   }
 
+  /**
+   * @return int
+   */
   function getCurrentNestingLevel() {
     return count($this->_parentStack);
   }
@@ -115,6 +124,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     return $this->_current;
   }
 
+  /**
+   * @return string
+   */
   function key() {
     $group = &$this->_current;
     $ids = array();
@@ -129,6 +141,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     return $key;
   }
 
+  /**
+   * @return CRM_Contact_BAO_Group|null
+   */
   function next() {
     $currentGroup = &$this->_current;
     $childGroup = $this->_getNextChildGroup($currentGroup);
@@ -160,6 +175,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     return $nextGroup;
   }
 
+  /**
+   * @return bool
+   */
   function valid() {
     if ($this->_current) {
       return TRUE;
@@ -169,6 +187,11 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     }
   }
 
+  /**
+   * @param null $group
+   *
+   * @return CRM_Contact_BAO_Group|null
+   */
   function _getNextParentlessGroup(&$group = NULL) {
     $lastParentlessGroup = $this->_lastParentlessGroup;
     $nextGroup           = new CRM_Contact_BAO_Group();
@@ -191,6 +214,12 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     return NULL;
   }
 
+  /**
+   * @param $parentGroup
+   * @param null $group
+   *
+   * @return CRM_Contact_BAO_Group|null
+   */
   function _getNextChildGroup(&$parentGroup, &$group = NULL) {
     $children = self::getChildGroupIds($parentGroup->id);
     if (count($children) > 0) {
@@ -217,6 +246,11 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     return NULL;
   }
 
+  /**
+   * @param $group
+   *
+   * @return CRM_Contact_BAO_Group|null
+   */
   function _getNextSiblingGroup(&$group) {
     $parentGroup = end($this->_parentStack);
     if ($parentGroup) {
@@ -664,6 +698,12 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
     return $potentialChildGroupIds;
   }
 
+  /**
+   * @param $contactId
+   * @param $parentGroupId
+   *
+   * @return array
+   */
   static function getContainingGroups($contactId, $parentGroupId) {
     $groups = CRM_Contact_BAO_Group::getGroups();
     $containingGroups = array();
index ff95b8e39e4e57dbfc54d02d68f07f5255e06ad0..6fa5bc88b00b06627ee0b4da6ce5be54bc5e457d 100644 (file)
@@ -97,6 +97,11 @@ WHERE  id = $id
     CRM_Core_BAO_Cache::setItem($tree, 'contact groups', 'nestable tree hierarchy');
   }
 
+  /**
+   * @param $tree
+   *
+   * @return bool
+   */
   static function checkCyclicGraph(&$tree) {
     // lets keep this simple, we should probably use a graph algoritm here at some stage
 
@@ -111,6 +116,12 @@ WHERE  id = $id
     return FALSE;
   }
 
+  /**
+   * @param $tree
+   * @param $id
+   *
+   * @return bool
+   */
   static function isCyclic(&$tree, $id) {
     $parents = $children = array();
     self::getAll($parent, $tree, $id, 'parents');
@@ -129,6 +140,12 @@ WHERE  id = $id
     return FALSE;
   }
 
+  /**
+   * @param $id
+   * @param $groups
+   *
+   * @return array
+   */
   static function getPotentialCandidates($id, &$groups) {
     $tree = CRM_Core_BAO_Cache::getItem('contact groups', 'nestable tree hierarchy');
 
@@ -148,6 +165,12 @@ WHERE  id = $id
     return array_keys($potential);
   }
 
+  /**
+   * @param $potential
+   * @param $tree
+   * @param $id
+   * @param $token
+   */
   static function invalidate(&$potential, &$tree, $id, $token) {
     unset($potential[$id]);
 
@@ -162,6 +185,12 @@ WHERE  id = $id
     }
   }
 
+  /**
+   * @param $all
+   * @param $tree
+   * @param $id
+   * @param $token
+   */
   static function getAll(&$all, &$tree, $id, $token) {
     // if seen before, dont do anything
     if (isset($all[$id])) {
@@ -180,6 +209,9 @@ WHERE  id = $id
     }
   }
 
+  /**
+   * @return string
+   */
   static function json() {
     $tree = CRM_Core_BAO_Cache::getItem('contact groups', 'nestable tree hierarchy');
 
index 93f74806451b1d86339b619da6002294d9daa39f..c5db6ed18bf036ecdd8503cba9999826861b283e 100644 (file)
@@ -107,6 +107,10 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
     return FALSE;
   }
 
+  /**
+   * @param $groupID
+   * @param $defaults
+   */
   static function retrieve($groupID, &$defaults) {
     $dao = new CRM_Contact_DAO_GroupOrganization();
     $dao->group_id = $groupID;
index 6b58e8fc9fb0c57ef9d0665eaae381510d8f2ace..b88a412044238b2c3ac0ace23eae1f5418756853 100644 (file)
@@ -185,6 +185,14 @@ class CRM_Contact_BAO_ProximityQuery {
     );
   }
 
+  /**
+   * @param $latitude
+   * @param $longitude
+   * @param $distance
+   * @param string $tablePrefix
+   *
+   * @return string
+   */
   static function where($latitude, $longitude, $distance, $tablePrefix = 'civicrm_address') {
     self::initialize();
 
@@ -233,6 +241,12 @@ ACOS(
     return $where;
   }
 
+  /**
+   * @param $query
+   * @param $values
+   *
+   * @throws Exception
+   */
   static function process(&$query, &$values) {
     list($name, $op, $distance, $grouping, $wildcard) = $values;
 
@@ -337,6 +351,9 @@ ACOS(
     return;
   }
 
+  /**
+   * @param $input
+   */
   static function fixInputParams(&$input) {
     foreach ($input as $param) {
       if (CRM_Utils_Array::value('0', $param) == 'prox_distance') {
index a0a0478e9660a2166e3afc2042caeba9474302dd..c388494e28e64ce5a1e1edac8ac276b4d3c45f07 100644 (file)
@@ -618,7 +618,7 @@ class CRM_Contact_BAO_Query {
 
       // redirect to activity select clause
       if (
-        (substr($name, 0, 9) == 'activity_') || 
+        (substr($name, 0, 9) == 'activity_') ||
         ($name == 'parent_id')
       ) {
         CRM_Activity_BAO_Query::select($this);
@@ -1355,6 +1355,12 @@ class CRM_Contact_BAO_Query {
     return array($select, $from, $where, $having);
   }
 
+  /**
+   * @param $name
+   * @param $grouping
+   *
+   * @return null
+   */
   function &getWhereValues($name, $grouping) {
     $result = NULL;
     foreach ($this->_params as $values) {
@@ -1366,12 +1372,24 @@ class CRM_Contact_BAO_Query {
     return $result;
   }
 
+  /**
+   * @param $relative
+   * @param $from
+   * @param $to
+   */
   static function fixDateValues($relative, &$from, &$to) {
     if ($relative) {
       list($from, $to) = CRM_Utils_Date::getFromTo($relative, $from, $to);
     }
   }
 
+  /**
+   * @param $formValues
+   * @param int $wildcard
+   * @param bool $useEquals
+   *
+   * @return array
+   */
   static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE) {
     $params = array();
     if (empty($formValues)) {
@@ -1434,6 +1452,14 @@ class CRM_Contact_BAO_Query {
     return $params;
   }
 
+  /**
+   * @param $id
+   * @param $values
+   * @param int $wildcard
+   * @param bool $useEquals
+   *
+   * @return array|null
+   */
   static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE) {
     // skip a few search variables
     static $skipWhere = NULL;
@@ -1515,6 +1541,9 @@ class CRM_Contact_BAO_Query {
     return $result;
   }
 
+  /**
+   * @param $values
+   */
   function whereClauseSingle(&$values) {
     // do not process custom fields or prefixed contact ids or component params
     if (CRM_Core_BAO_CustomField::getKeyID($values[0]) ||
@@ -1826,6 +1855,11 @@ class CRM_Contact_BAO_Query {
     return implode(' AND ', $andClauses);
   }
 
+  /**
+   * @param $values
+   *
+   * @throws Exception
+   */
   function restWhere(&$values) {
     $name = CRM_Utils_Array::value(0, $values);
     $op = CRM_Utils_Array::value(1, $values);
@@ -2135,6 +2169,13 @@ class CRM_Contact_BAO_Query {
   }
 
 
+  /**
+   * @param $where
+   * @param $locType
+   *
+   * @return array
+   * @throws Exception
+   */
   static function getLocationTableName(&$where, &$locType) {
     if (isset($locType[1]) && is_numeric($locType[1])) {
       list($tbName, $fldName) = explode(".", $where);
@@ -2232,6 +2273,9 @@ class CRM_Contact_BAO_Query {
     return $this->_tables;
   }
 
+  /**
+   * @return array
+   */
   function whereTables() {
     return $this->_whereTables;
   }
@@ -2591,6 +2635,10 @@ class CRM_Contact_BAO_Query {
     $this->includeContactSubTypes($value, $grouping);
   }
 
+  /**
+   * @param $value
+   * @param $grouping
+   */
   function includeContactSubTypes($value, $grouping) {
 
     $clause = array();
@@ -2713,6 +2761,11 @@ class CRM_Contact_BAO_Query {
   /*
    * Function translates selection of group type into a list of groups
    */
+  /**
+   * @param $value
+   *
+   * @return array
+   */
   function getGroupsFromTypeCriteria($value){
     $groupIds = array();
     foreach ($value as $groupTypeValue) {
@@ -3015,6 +3068,13 @@ WHERE  id IN ( $groupIDs )
     $this->_qill[$grouping][] = $label . " $op - '$n'";
   }
 
+  /**
+   * @param $name
+   * @param $op
+   * @param $grouping
+   *
+   * @return bool
+   */
   function nameNullOrEmptyOp($name, $op, $grouping) {
     switch ( $op ) {
       case 'IS NULL':
@@ -3466,6 +3526,12 @@ WHERE  id IN ( $groupIDs )
     }
   }
 
+  /**
+   * @param $values
+   * @param bool $fromStateProvince
+   *
+   * @return array
+   */
   function country(&$values, $fromStateProvince = TRUE) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
 
@@ -3735,6 +3801,9 @@ WHERE  id IN ( $groupIDs )
     $this->_qill[$grouping][] = ts('Modified by') . ": $name";
   }
 
+  /**
+   * @param $values
+   */
   function modifiedDates($values) {
     $this->_useDistinct = TRUE;
 
@@ -3756,6 +3825,9 @@ WHERE  id IN ( $groupIDs )
     self::$_openedPanes[ts('Change Log')] = TRUE;
   }
 
+  /**
+   * @param $values
+   */
   function demographics(&$values) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
 
@@ -3775,6 +3847,9 @@ WHERE  id IN ( $groupIDs )
     self::$_openedPanes[ts('Demographics')] = TRUE;
   }
 
+  /**
+   * @param $values
+   */
   function privacy(&$values) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
     //fixed for profile search listing CRM-4633
@@ -3791,6 +3866,9 @@ WHERE  id IN ( $groupIDs )
     $this->_qill[$grouping][] = "$title $op $value";
   }
 
+  /**
+   * @param $values
+   */
   function privacyOptions($values) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
 
@@ -3828,6 +3906,9 @@ WHERE  id IN ( $groupIDs )
     $this->_qill[$grouping][] = implode($operator, $qill);
   }
 
+  /**
+   * @param $values
+   */
   function preferredCommunication(&$values) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
 
@@ -4573,10 +4654,18 @@ civicrm_relationship.is_permission_a_b = 0
     }
   }
 
+  /**
+   * @param $val
+   */
   function setSkipPermission($val) {
     $this->_skipPermission = $val;
   }
 
+  /**
+   * @param null $context
+   *
+   * @return array
+   */
   function &summaryContribution($context = NULL) {
     list($innerselect, $from, $where, $having) = $this->query(TRUE);
 
@@ -4799,6 +4888,14 @@ SELECT COUNT( conts.total_amount ) as cancel_count,
     return self::$_defaultHierReturnProperties;
   }
 
+  /**
+   * @param $values
+   * @param $tableName
+   * @param $fieldName
+   * @param $dbFieldName
+   * @param $fieldTitle
+   * @param bool $appendTimeStamp
+   */
   function dateQueryBuilder(
     &$values, $tableName, $fieldName,
     $dbFieldName, $fieldTitle,
@@ -4904,6 +5001,14 @@ SELECT COUNT( conts.total_amount ) as cancel_count,
     }
   }
 
+  /**
+   * @param $values
+   * @param $tableName
+   * @param $fieldName
+   * @param $dbFieldName
+   * @param $fieldTitle
+   * @param null $options
+   */
   function numberRangeBuilder(&$values,
     $tableName, $fieldName,
     $dbFieldName, $fieldTitle,
@@ -5043,6 +5148,11 @@ SELECT COUNT( conts.total_amount ) as cancel_count,
     }
   }
 
+  /**
+   * @param bool $reset
+   *
+   * @return array
+   */
   function openedSearchPanes($reset = FALSE) {
     if (!$reset || empty($this->_whereTables)) {
       return self::$_openedPanes;
@@ -5074,6 +5184,9 @@ SELECT COUNT( conts.total_amount ) as cancel_count,
     return self::$_openedPanes;
   }
 
+  /**
+   * @param $operator
+   */
   function setOperator($operator) {
     $validOperators = array('AND', 'OR');
     if (!in_array($operator, $validOperators)) {
@@ -5082,10 +5195,18 @@ SELECT COUNT( conts.total_amount ) as cancel_count,
     $this->_operator = $operator;
   }
 
+  /**
+   * @return string
+   */
   function getOperator() {
     return $this->_operator;
   }
 
+  /**
+   * @param $from
+   * @param $where
+   * @param $having
+   */
   function filterRelatedContacts(&$from, &$where, &$having) {
     static $_rTypeProcessed = NULL;
     static $_rTypeFrom = NULL;
@@ -5157,11 +5278,22 @@ AND   displayRelType.is_active = 1
     $having = NULL;
   }
 
+  /**
+   * @param $op
+   *
+   * @return bool
+   */
   static function caseImportant( $op ) {
     return
       in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE;
   }
 
+  /**
+   * @param $returnProperties
+   * @param $prefix
+   *
+   * @return bool
+   */
   static function componentPresent( &$returnProperties, $prefix ) {
     foreach ($returnProperties as $name => $dontCare ) {
       if (substr($name, 0, strlen($prefix)) == $prefix) {
index 733b6becc473e0acd8095f6c3ed42c391ba75072..234d584fe608c4da0bb43523b3a155e88594597a 100644 (file)
@@ -71,6 +71,9 @@ class CRM_Contact_BAO_Query_Hook {
     return $this->_queryObjects;
   }
 
+  /**
+   * @return array
+   */
   public function &getFields() {
     $extFields = array();
     foreach (self::getSearchQueryObjects() as $obj) {
@@ -80,18 +83,33 @@ class CRM_Contact_BAO_Query_Hook {
     return $extFields;
   }
 
+  /**
+   * @param $apiEntities
+   * @param $fieldOptions
+   */
   public function alterSearchBuilderOptions(&$apiEntities, &$fieldOptions) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->alterSearchBuilderOptions($apiEntities, $fieldOptions);
     }
   }
 
+  /**
+   * @param $query
+   * @param $fnName
+   */
   public function alterSearchQuery(&$query, $fnName) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->$fnName($query);
     }
   }
 
+  /**
+   * @param $fieldName
+   * @param $mode
+   * @param $side
+   *
+   * @return string
+   */
   public function buildSearchfrom($fieldName, $mode, $side) {
     $from = '';
     foreach (self::getSearchQueryObjects() as $obj) {
@@ -100,30 +118,47 @@ class CRM_Contact_BAO_Query_Hook {
     return $from;
   }
 
+  /**
+   * @param $tables
+   */
   public function setTableDependency(&$tables) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->setTableDependency($tables);
     }
   }
 
+  /**
+   * @param $panes
+   */
   public function registerAdvancedSearchPane(&$panes) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->registerAdvancedSearchPane($panes);
     }
   }
 
+  /**
+   * @param $panes
+   */
   public function getPanesMapper(&$panes) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->getPanesMapper($panes);
     }
   }
 
+  /**
+   * @param $form
+   * @param $type
+   */
   public function buildAdvancedSearchPaneForm(&$form, $type) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->buildAdvancedSearchPaneForm($form, $type);
     }
   }
 
+  /**
+   * @param $paneTemplatePathArray
+   * @param $type
+   */
   public function setAdvancedSearchPaneTemplatePath(&$paneTemplatePathArray, $type) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->setAdvancedSearchPaneTemplatePath($paneTemplatePathArray, $type);
index 328483c270ab79e886f4e5ecae198f07b0d6f58b..26e6303e2b70a607d66b2c7c8f15a98b74d3819c 100644 (file)
 abstract class CRM_Contact_BAO_Query_Interface {
 
   abstract public function &getFields();
+
+  /**
+   * @param $fieldName
+   * @param $mode
+   * @param $side
+   *
+   * @return mixed
+   */
   abstract public function from($fieldName, $mode, $side);
 
+  /**
+   * @param $query
+   *
+   * @return null
+   */
   public function select(&$query) {
     return NULL;
   }
 
+  /**
+   * @param $query
+   *
+   * @return null
+   */
   public function where(&$query) {
     return NULL;
   }
 
+  /**
+   * @param $tables
+   *
+   * @return null
+   */
   public function setTableDependency(&$tables) {
     return NULL;
   }
 
+  /**
+   * @param $panes
+   *
+   * @return null
+   */
   public function registerAdvancedSearchPane(&$panes) {
     return NULL;
   }
 
+  /**
+   * @param $form
+   * @param $type
+   *
+   * @return null
+   */
   public function buildAdvancedSearchPaneForm(&$form, $type) {
     return NULL;
   }
 
+  /**
+   * @param $paneTemplatePathArray
+   * @param $type
+   *
+   * @return null
+   */
   public function setAdvancedSearchPaneTemplatePath(&$paneTemplatePathArray, $type) {
     return NULL;
   }
@@ -80,4 +120,4 @@ abstract class CRM_Contact_BAO_Query_Interface {
    */
   public function alterSearchBuilderOptions(&$apiEntities, &$fieldOptions) {
   }
-}
\ No newline at end of file
+}
index 616e93b6f1ad57741079db416d9ff3429f811422..dc0c90821c25829a901d82cd88c6696727e95a57 100644 (file)
@@ -423,6 +423,12 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship {
     return $relationshipType;
   }
 
+  /**
+   * @param $id
+   * @param $action
+   *
+   * @return CRM_Contact_DAO_Relationship
+   */
   static function clearCurrentEmployer($id, $action) {
     $relationship = new CRM_Contact_DAO_Relationship();
     $relationship->id = $id;
index 95c46916087580924c2feb655368b6b8e2f4c6a4..c9fe0967691d48a903bd2b13f3159b833acec93a 100644 (file)
@@ -130,6 +130,11 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch {
     return $result;
   }
 
+  /**
+   * @param $id
+   *
+   * @return array
+   */
   static function getSearchParams($id) {
     $fv = self::getFormValues($id);
     //check if the saved seach has mapping id
@@ -167,6 +172,11 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch {
     return NULL;
   }
 
+  /**
+   * @param $id
+   *
+   * @return string
+   */
   static function contactIDsSQL($id) {
     $params = self::getSearchParams($id);
     if ($params && !empty($params['customSearchID'])) {
@@ -186,6 +196,11 @@ WHERE  $where";
     }
   }
 
+  /**
+   * @param $id
+   *
+   * @return array
+   */
   static function fromWhereEmail($id) {
     $params = self::getSearchParams($id);
 
index 4af8f5b423226ef01c376f6bcecac6e05a47ec04..7d720f3a2a334ab3f3010173980d69c51f756e0f 100644 (file)
  */
 class CRM_Contact_BAO_SearchCustom {
 
+  /**
+   * @param $csID
+   * @param null $ssID
+   * @param null $gID
+   *
+   * @return array
+   * @throws Exception
+   */
   static function details($csID, $ssID = NULL, $gID = NULL) {
     $error = array(NULL, NULL, NULL);
 
@@ -91,6 +99,13 @@ class CRM_Contact_BAO_SearchCustom {
     return array($customSearchID, $customSearchClass, $formValues);
   }
 
+  /**
+   * @param $csID
+   * @param $ssID
+   *
+   * @return mixed
+   * @throws Exception
+   */
   static function customClass($csID, $ssID) {
     list($customSearchID, $customSearchClass, $formValues) = self::details($csID, $ssID);
 
@@ -104,11 +119,22 @@ class CRM_Contact_BAO_SearchCustom {
     return $customClass;
   }
 
+  /**
+   * @param $csID
+   * @param $ssID
+   *
+   * @return mixed
+   */
   static function contactIDSQL($csID, $ssID) {
     $customClass = self::customClass($csID, $ssID);
     return $customClass->contactIDs();
   }
 
+  /**
+   * @param $args
+   *
+   * @return array
+   */
   static function &buildFormValues($args) {
     $args = trim($args);
 
@@ -123,6 +149,12 @@ class CRM_Contact_BAO_SearchCustom {
     return $formValues;
   }
 
+  /**
+   * @param $csID
+   * @param $ssID
+   *
+   * @return array
+   */
   static function fromWhereEmail($csID, $ssID) {
     $customClass = self::customClass($csID, $ssID);
 
index 11d643c14886ba0f8b5ade854303b7979db69825..09fe3ec06cf8c6205c481e373f79df5666e4b7b9 100644 (file)
  * BAO object for crm_email table
  */
 class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHistory {
+  /**
+   * class constructor
+   *
+   * @access public
+   * @return \CRM_Contact_DAO_SubscriptionHistory
+   */
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
   }
index 542fb268406e04c98e934c8d051fa96ed609206b..a56bbbb788cd01ac533f9ea7bf213e69c6b64b0f 100644 (file)
@@ -61,6 +61,9 @@ class CRM_Contact_Controller_Search extends CRM_Core_Controller {
     $this->addActions();
   }
 
+  /**
+   * @return mixed
+   */
   public function selectorName() {
     return $this->get('selectorName');
   }
index 419885a19dd893dcec6880cfdac1ad0d41e84bec..27d264fb2edab6e81b83762b02a7c0618e9ca93c 100644 (file)
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Class CRM_Contact_DAO_Factory
+ */
 class CRM_Contact_DAO_Factory {
 
   static $_classes = array(
@@ -23,6 +26,11 @@ class CRM_Contact_DAO_Factory {
 
   static $_suffix = '.php';
 
+  /**
+   * @param $className
+   *
+   * @return mixed
+   */
   static function &create($className) {
     $type = CRM_Utils_Array::value($className, self::$_classes);
     if (!$type) {
index cd601261958e0f16ee7d9f7a8147b5ec9f1669f4..40abe4743c3a5ca80dee745325a157f4edfdeaf5 100644 (file)
@@ -1187,6 +1187,15 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form {
     }
   }
 
+  /**
+   * Use the form name to create the tpl file name
+   *
+   * @return string
+   * @access public
+   */
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
     if ($this->_contactSubType) {
       $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl";
index 0a6c4665d8e639427329316938b2290855ba0a2e..faa8c5bc93c6952ce690915efc13746c60db82ef 100644 (file)
@@ -174,6 +174,17 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form {
     return empty($errors) ? TRUE : $errors;
   }
 
+  /**
+   * This function sets the default values for the form. MobileProvider that in edit/view mode
+   * the default values are retrieved from the database
+   *
+   * @access public
+   *
+   * @return array
+   */
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     return $this->_defaults;
   }
index 1ca1d0ee75306b0eeedbe35d07b7ad308bc87c47..b958f8fd27cb37dadc0fc748d739fc90bfeb68cb 100644 (file)
@@ -97,6 +97,18 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form {
    * @access public
    * @return void
    */
+  /**
+   * This virtual function is used to set the default values of
+   * various form elements
+   *
+   * access        public
+   *
+   * @return array reference to the array of default values
+   *
+   */
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     $defaults  = array();
     $params    = array();
index c786bfaab457b3659146a1725ebb9b82aa8cbe50..d76a4379a60d895b7ba9dc440ba811c1c451bc56 100644 (file)
@@ -397,6 +397,14 @@ class CRM_Contact_Form_Edit_Address {
     return empty($errors) ? TRUE : $errors;
   }
 
+  /**
+   * @param $form
+   * @param $countryElementName
+   * @param $stateElementName
+   * @param $countyElementName
+   * @param $countryDefaultValue
+   * @param null $stateDefaultValue
+   */
   static function fixStateSelect(&$form,
     $countryElementName,
     $stateElementName,
@@ -570,6 +578,10 @@ class CRM_Contact_Form_Edit_Address {
   }
 
 
+  /**
+   * @param $form
+   * @param $groupTree
+   */
   static function storeRequiredCustomDataInfo(&$form, $groupTree) {
     if (CRM_Utils_System::getClassName($form) == 'CRM_Contact_Form_Contact') {
       $requireOmission = NULL;
index d86b0a8a2c9d5833c4d0de30b4f15bce608da8ed..57465feaf0fdaefe38bc36bbd823faf7fdbf5634 100644 (file)
@@ -86,6 +86,13 @@ class CRM_Contact_Form_Edit_Organization {
     }
   }
 
+  /**
+   * @param $fields
+   * @param $files
+   * @param null $contactID
+   *
+   * @return array|bool
+   */
   static function formRule($fields, $files, $contactID = NULL) {
     $errors = array();
     $primaryID = CRM_Contact_Form_Contact::formRule($fields, $errors, $contactID);
index 61cbf0df793bf1a3c4ab46c63c15c45291fc0b51..d818628bc16b01f8cf337d8b9b88677b43d25d0a 100644 (file)
  */
 
 require_once 'api/api.php';
+
+/**
+ * Class CRM_Contact_Form_Merge
+ */
 class CRM_Contact_Form_Merge extends CRM_Core_Form {
   // the id of the contact that tere's a duplicate for; this one will
   // possibly inherit some of $_oid's properties and remain in the system
@@ -244,6 +248,18 @@ class CRM_Contact_Form_Merge extends CRM_Core_Form {
     $this->assign('userContextURL', $session->readUserContext());
   }
 
+  /**
+   * This virtual function is used to set the default values of
+   * various form elements
+   *
+   * access        public
+   *
+   * @return array reference to the array of default values
+   *
+   */
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     return array('deleteOther' => 1);
   }
@@ -296,6 +312,13 @@ class CRM_Contact_Form_Merge extends CRM_Core_Form {
     $this->addFormRule(array('CRM_Contact_Form_Merge', 'formRule'), $this);
   }
 
+  /**
+   * @param $fields
+   * @param $files
+   * @param $self
+   *
+   * @return array
+   */
   static function formRule($fields, $files, $self) {
     $errors = array();
     $link = CRM_Utils_System::href(ts('Flip between the original and duplicate contacts.'),
index c8bd5eac4e6a8e8d8181acd339ab1ada376c035b..b6f12cbf5703130978171c2a2fb2859c98d964da 100644 (file)
@@ -111,6 +111,9 @@ class CRM_Contact_Form_ProfileContact {
     }
   }
 
+  /**
+   * @param $form
+   */
   static function postProcess($form) {
     $params = $form->_params;
     if (!empty($form->_honor_block_is_active) && !empty($params['soft_credit_type_id'])) {
index 1f963e3b74fa85c056a6fc7a6c5e24e2975247b1..2fb29196fcb4a79daf141c91cfa97f4b269660f5 100644 (file)
@@ -245,6 +245,11 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
     return self::$_validContext;
   }
 
+  /**
+   * @param $context
+   *
+   * @return bool
+   */
   static function isSearchContext($context) {
     $searchContext = CRM_Utils_Array::value($context, self::validContext());
     return $searchContext ? TRUE : FALSE;
@@ -329,6 +334,11 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
     }
   }
 
+  /**
+   * @param int $mode
+   *
+   * @return mixed
+   */
   static function getModeValue($mode = 1) {
     self::setModeValues();
 
@@ -339,6 +349,9 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
     return self::$_modeValues[$mode];
   }
 
+  /**
+   * @return array
+   */
   static function getModeSelect() {
     self::setModeValues();
 
@@ -795,6 +808,9 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
     $controller->moveFromSessionToTemplate();
   }
 
+  /**
+   * @return array
+   */
   function &getFormValues() {
     return $this->_formValues;
   }
@@ -931,6 +947,9 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
     }
   }
 
+  /**
+   * @return null
+   */
   function &returnProperties() {
     return CRM_Core_DAO::$_nullObject;
   }
index 02a768d359f688859bed0b109d61d32b79075f66..ee086eb766123c529fb3fba2e5a2aa72bcdd6bc5 100644 (file)
@@ -177,6 +177,15 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search {
     }
   }
 
+  /**
+   * Use the form name to create the tpl file name
+   *
+   * @return string
+   * @access public
+   */
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
     if (!$this->_searchPane) {
       return parent::getTemplateFileName();
@@ -350,7 +359,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search {
         $this->_formValues['contact_tags'][$value] = 1;
       }
     }
-    
+
     // CRM-13848
     $financialType = CRM_Utils_Array::value('financial_type_id', $this->_formValues);
     if ($financialType && is_array($financialType)) {
@@ -359,7 +368,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search {
         $this->_formValues['financial_type_id'][$typeID] = 1;
       }
     }
-    
+
     $taglist = CRM_Utils_Array::value('contact_taglist', $this->_formValues);
 
     if ($taglist && is_array($taglist)) {
index f14088f7718b9b6a684d4103bcea5830cc4640e6..cbeca69e38f983c5e39e3fff77c73d36748f5eb3 100644 (file)
@@ -158,6 +158,9 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search {
     parent::preProcess();
   }
 
+  /**
+   * @return array
+   */
   function &getFormValues() {
     return $this->_formValues;
   }
@@ -276,6 +279,15 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search {
     return TRUE;
   }
 
+  /**
+   * Return a descriptive name for the page, used in wizard header
+   *
+   * @return string
+   * @access public
+   */
+  /**
+   * @return string
+   */
   function getTitle() {
     return ts('Find Contacts');
   }
index 656db4ff78d10ecf055a7bd5654fe13eeee44244..9a4b31bed947e54a9ad7ff0e342cc2b911ffb731 100644 (file)
@@ -302,10 +302,18 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search {
 
   public function normalizeFormValues() {}
 
+  /**
+   * @param $formValues
+   *
+   * @return array
+   */
   public function &convertFormValues(&$formValues) {
     return CRM_Core_BAO_Mapping::formattedFields($formValues);
   }
 
+  /**
+   * @return array
+   */
   public function &returnProperties() {
     return CRM_Core_BAO_Mapping::returnProperties($this->_formValues);
   }
@@ -398,6 +406,9 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search {
     parent::postProcess();
   }
 
+  /**
+   * @return array
+   */
   static function fields() {
     $fields = array_merge(
       CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE),
index b9cff19e731e86d42517cfd7e5406d9988db5b6a..1aee74b7443552576964216f8c03b93821f83747 100644 (file)
@@ -270,6 +270,9 @@ class CRM_Contact_Form_Search_Criteria {
   }
 
 
+  /**
+   * @param $form
+   */
   static function location(&$form) {
     // Build location criteria based on _submitValues if
     // available; otherwise, use $form->_formValues.
@@ -409,11 +412,17 @@ class CRM_Contact_Form_Search_Criteria {
     }
   }
 
+  /**
+   * @param $form
+   */
   static function activity(&$form) {
     $form->add('hidden', 'hidden_activity', 1);
     CRM_Activity_BAO_Query::buildSearchForm($form);
   }
 
+  /**
+   * @param $form
+   */
   static function changeLog(&$form) {
     $form->add('hidden', 'hidden_changeLog', 1);
 
@@ -426,10 +435,16 @@ class CRM_Contact_Form_Search_Criteria {
     CRM_Core_Form_Date::buildDateRange($form, 'log_date', 1, '_low', '_high', ts('From'), FALSE, FALSE);
   }
 
+  /**
+   * @param $form
+   */
   static function task(&$form) {
     $form->add('hidden', 'hidden_task', 1);
   }
 
+  /**
+   * @param $form
+   */
   static function relationship(&$form) {
     $form->add('hidden', 'hidden_relationship', 1);
 
@@ -477,6 +492,9 @@ class CRM_Contact_Form_Search_Criteria {
     }
   }
 
+  /**
+   * @param $form
+   */
   static function demographics(&$form) {
     $form->add('hidden', 'hidden_demographics', 1);
     // radio button for gender
@@ -499,6 +517,9 @@ class CRM_Contact_Form_Search_Criteria {
     $form->addYesNo( 'is_deceased', ts('Deceased'), TRUE);
   }
 
+  /**
+   * @param $form
+   */
   static function notes(&$form) {
     $form->add('hidden', 'hidden_notes', 1);
 
@@ -555,6 +576,9 @@ class CRM_Contact_Form_Search_Criteria {
     //TODO: validate for only one state if prox_distance isset
   }
 
+  /**
+   * @param $form
+   */
   static function CiviCase(&$form) {
     //Looks like obsolete code, since CiviCase is a component, but might be used by HRD
     $form->add('hidden', 'hidden_CiviCase', 1);
index 5fb1158ca37d65d42d0d2950c38d2479e1b18db5..eabfe7dce82b105ba68677e7079b69e5f53fefb5 100644 (file)
@@ -89,6 +89,18 @@ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search {
     }
   }
 
+  /**
+   * This virtual function is used to set the default values of
+   * various form elements
+   *
+   * access        public
+   *
+   * @return array reference to the array of default values
+   *
+   */
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     if (method_exists($this->_customSearchClass, 'setDefaultValues')) {
       return $this->_customClass->setDefaultValues();
@@ -102,6 +114,15 @@ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search {
     parent::buildQuickForm();
   }
 
+  /**
+   * Use the form name to create the tpl file name
+   *
+   * @return string
+   * @access public
+   */
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
 
     $ext = CRM_Extension_System::singleton()->getMapper();
@@ -135,10 +156,24 @@ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search {
     parent::postProcess();
   }
 
+  /**
+   * Return a descriptive name for the page, used in wizard header
+   *
+   * @return string
+   * @access public
+   */
+  /**
+   * @return string
+   */
   public function getTitle() {
     return ts('Custom Search');
   }
 
+  /**
+   * @param $components
+   *
+   * @return bool
+   */
   function isPermissioned($components) {
     if (empty($components)) {
       return TRUE;
index 2e08a2561ca5f0569ec2b130cd6c808c68bbcf0e..03cacff34fec920e4332311531bd6480fc1b7efd 100644 (file)
@@ -36,6 +36,12 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_
 
   protected $_formValues;
 
+  /**
+   * @param $formValues
+   */
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = $formValues;
 
@@ -83,6 +89,9 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_
     //end custom fields
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     /**
@@ -223,11 +232,17 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_
 
   // Alters the date display in the Activity Date Column. We do this after we already have
   // the result so that sorting on the date column stays pertinent to the numeric date value
+  /**
+   * @param $row
+   */
   function alterRow(&$row) {
     $row['activity_date'] = CRM_Utils_Date::customFormat($row['activity_date'], '%B %E%f, %Y %l:%M %P');
   }
 
   // Regular JOIN statements here to limit results to contacts who have activities.
+  /**
+   * @return string
+   */
   function from() {
     $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
@@ -260,6 +275,11 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_
      * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
      *
      */
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $clauses = array();
 
@@ -342,14 +362,27 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_
     return $dao->N;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     return $this->_columns;
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
@@ -359,6 +392,9 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_
     }
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
index e9767667d91a4cb2fd6da75236292b5b1b7329bd..5ef3c868e169662e7b0a17941c02d25635791f81 100644 (file)
@@ -40,18 +40,35 @@ class CRM_Contact_Form_Search_Custom_Base {
 
   protected $_stateID;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = &$formValues;
   }
 
+  /**
+   * @return null|string
+   */
   function count() {
     return CRM_Core_DAO::singleValueQuery($this->sql('count(distinct contact_a.id) as total'));
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $returnSQL
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) {
     $sql = $this->sql(
       'contact_a.id as contact_id',
@@ -68,6 +85,16 @@ class CRM_Contact_Form_Search_Custom_Base {
     return CRM_Core_DAO::composeQuery($sql, CRM_Core_DAO::$_nullArray);
   }
 
+  /**
+   * @param $selectClause
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param null $groupBy
+   *
+   * @return string
+   */
   function sql(
     $selectClause,
     $offset   = 0,
@@ -97,6 +124,9 @@ class CRM_Contact_Form_Search_Custom_Base {
     return $sql;
   }
 
+  /**
+   * @return null
+   */
   function templateFile() {
     return NULL;
   }
@@ -105,6 +135,10 @@ class CRM_Contact_Form_Search_Custom_Base {
     return $this->_columns;
   }
 
+  /**
+   * @param $sql
+   * @param $formValues
+   */
   static function includeContactIDs(&$sql, &$formValues) {
     $contactIDs = array();
     foreach ($formValues as $id => $value) {
@@ -121,6 +155,12 @@ class CRM_Contact_Form_Search_Custom_Base {
     }
   }
 
+  /**
+   * @param $sql
+   * @param $offset
+   * @param $rowcount
+   * @param $sort
+   */
   function addSortOffset(&$sql, $offset, $rowcount, $sort) {
     if (!empty($sort)) {
       if (is_string($sort)) {
@@ -140,6 +180,12 @@ class CRM_Contact_Form_Search_Custom_Base {
     }
   }
 
+  /**
+   * @param $sql
+   * @param bool $onlyWhere
+   *
+   * @throws Exception
+   */
   function validateUserSQL(&$sql, $onlyWhere = FALSE) {
     $includeStrings = array('contact_a');
     $excludeStrings = array('insert', 'delete', 'update');
@@ -165,12 +211,21 @@ class CRM_Contact_Form_Search_Custom_Base {
     }
   }
 
+  /**
+   * @param $where
+   * @param $params
+   *
+   * @return string
+   */
   function whereClause(&$where, &$params) {
     return CRM_Core_DAO::composeQuery($where, $params, TRUE);
   }
 
   // override this method to define the contact query object
   // used for creating $sql
+  /**
+   * @return null
+   */
   function getQueryObj() {
     return NULL;
   }
index 9be5725abc877c5a4fa3f184f10487b97ae2ecc0..97ab38508bc9eb3d5dd5d06a60c28fb03bac950c 100644 (file)
@@ -36,6 +36,12 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo
 
   protected $_query;
 
+  /**
+   * @param $formValues
+   */
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -104,6 +110,9 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo
     return;
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
     //@todo FIXME - using the CRM_Core_DAO::VALUE_SEPARATOR creates invalid html - if you can find the form
     // this is loaded onto then replace with something like '__' & test
@@ -125,10 +134,22 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo
     $form->assign('elements', array('sort_name', 'contact_type', 'group', 'tag'));
   }
 
+  /**
+   * @return CRM_Contact_DAO_Contact
+   */
   function count() {
     return $this->_query->searchQuery(0, 0, NULL, TRUE);
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowCount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return CRM_Contact_DAO_Contact
+   */
   function all(
     $offset = 0,
     $rowCount = 0,
@@ -148,10 +169,18 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return $this->_query->_fromClause;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string|void
+   */
   function where($includeContactIDs = FALSE) {
     if ($whereClause = $this->_query->whereClause()) {
       return $whereClause;
@@ -159,10 +188,16 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo
     return ' (1) ';
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Basic.tpl';
   }
 
+  /**
+   * @return CRM_Contact_BAO_Query
+   */
   function getQueryObj() {
     return $this->_query;
   }
index c2d69cf1097a655c6a99b3a3879db7d0b327bfb9..a07b5c3f60226e5cd375df6ee527e45de4f76964 100644 (file)
@@ -37,6 +37,9 @@ class CRM_Contact_Form_Search_Custom_ContribSYBNT implements CRM_Contact_Form_Se
   protected $_formValues;
   public $_permissionedComponent;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = $formValues;
     $this->_permissionedComponent = 'CiviContribute';
@@ -81,6 +84,9 @@ class CRM_Contact_Form_Search_Custom_ContribSYBNT implements CRM_Contact_Form_Se
     }
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     foreach ($this->_amounts as $name => $title) {
@@ -113,10 +119,26 @@ class CRM_Contact_Form_Search_Custom_ContribSYBNT implements CRM_Contact_Form_Se
     return $dao->N;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all(
     $offset = 0,
     $rowcount = 0,
@@ -167,6 +189,9 @@ ORDER BY   donation_amount desc
     return $sql;
   }
 
+  /**
+   * @return string
+   */
   function select() {
     if ($this->start_date_2 || $this->end_date_2) {
       return "
@@ -182,6 +207,9 @@ count(contrib_1.id) AS donation_count
     }
   }
 
+  /**
+   * @return null|string
+   */
   function from() {
     $from = NULL;
     if ($this->start_date_2 || $this->end_date_2) {
@@ -198,6 +226,11 @@ count(contrib_1.id) AS donation_count
     return $from;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $clauses = array();
 
@@ -296,6 +329,11 @@ AND      c.receive_date < {$this->start_date_1}
     return implode(' AND ', $clauses);
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function having($includeContactIDs = FALSE) {
     $clauses = array();
     $min = CRM_Utils_Array::value('min_amount', $this->_formValues);
@@ -311,18 +349,30 @@ AND      c.receive_date < {$this->start_date_1}
     return implode(' AND ', $clauses);
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     return $this->_columns;
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom/ContribSYBNT.tpl';
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index c00b6fbed9741ba700119ba05361f2b47556c10c..3cab0ced25ae6e2061d00d780a18b6e79359b137 100644 (file)
@@ -37,6 +37,9 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate implements CRM_Contac
   protected $_formValues;
   public $_permissionedComponent;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = $formValues;
     /**
@@ -54,6 +57,9 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate implements CRM_Contac
     $this->_permissionedComponent = 'CiviContribute';
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     /**
@@ -158,6 +164,9 @@ $having
     return $sql;
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
 civicrm_contribution AS contrib,
@@ -169,6 +178,11 @@ civicrm_contact AS contact_a
       * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
       *
       */
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $clauses = array();
 
@@ -209,6 +223,11 @@ civicrm_contact AS contact_a
     return implode(' AND ', $clauses);
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function having($includeContactIDs = FALSE) {
     $clauses = array();
     $min = CRM_Utils_Array::value('min_amount', $this->_formValues);
@@ -238,14 +257,27 @@ civicrm_contact AS contact_a
     return $dao->N;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     return $this->_columns;
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
@@ -255,6 +287,9 @@ civicrm_contact AS contact_a
     }
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
index fedac0742b27d134ab52a8c8859bc7180dba4cc6..1511d59440141d832c8b3d106935d9ec828ebc6a 100644 (file)
@@ -36,6 +36,9 @@ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_C
 
   protected $_debug = 0;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -50,6 +53,9 @@ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_C
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
     $form->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'custom'));
     $form->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'custom'));
@@ -96,10 +102,22 @@ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_C
     $form->assign('elements', array('start_date', 'end_date', 'includeGroups', 'excludeGroups'));
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
   ) {
@@ -138,6 +156,9 @@ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_C
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     //define table name
     $randomNum = md5(uniqid());
@@ -354,14 +375,25 @@ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_C
     return $from;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     return '(1)';
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom.tpl';
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index 7c238995376810994e20f12ddae3f34b5fedc050..ca42ad05a22876c2ca1d0d46a6e9401929c20768 100644 (file)
@@ -36,6 +36,9 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
 
   protected $_formValues;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = $formValues;
 
@@ -51,6 +54,9 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     /**
@@ -79,6 +85,9 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
   /*
      * Set search form field defaults here.
      */
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     // Setting default search state to California
     return array(
@@ -153,6 +162,9 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
     return $sql;
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
             civicrm_relationship cR,
@@ -171,6 +183,11 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
      * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
      *
      */
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $clauses = array();
 
@@ -218,6 +235,11 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
     return implode(' AND ', $clauses);
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function having($includeContactIDs = FALSE) {
     $clauses = array();
     return implode(' AND ', $clauses);
@@ -235,14 +257,27 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
     return $dao->N;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
     return $this->all($offset, $rowcount, $sort);
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     return $this->_columns;
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
@@ -252,6 +287,9 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
     }
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
index d86a00248e13b3226ab77b7f584f4c2058f8da02..f250e223dc6d67679d74ba4538a19717bfbf86a2 100644 (file)
@@ -37,6 +37,9 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea
   protected $_formValues;
   public $_permissionedComponent;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = $formValues;
     $this->_permissionedComponent = array('CiviContribute', 'CiviEvent');
@@ -55,6 +58,9 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     /**
@@ -171,6 +177,9 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea
     return $sql;
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
         civicrm_participant_payment
@@ -191,6 +200,11 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea
      * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
      *
      */
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $clauses = array();
 
@@ -242,6 +256,9 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea
 
 
   /* This function does a query to get totals for some of the search result columns and returns a totals array. */
+  /**
+   * @return array
+   */
   function summary() {
     $totalSelect = "
         SUM(civicrm_contribution.total_amount) as payment_amount,COUNT(civicrm_participant.id) as participant_count,
@@ -294,14 +311,27 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea
     return $dao->N;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
     return $this->all($offset, $rowcount, $sort);
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     return $this->_columns;
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index 08f54f7cd7740a187e22158deaeb575d528b4b7e..16c8a8d06a2a08edc20d32a848ad0edb43d975a7 100644 (file)
@@ -63,6 +63,9 @@ class CRM_Contact_Form_Search_Custom_FullText implements CRM_Contact_Form_Search
 
   protected $_foundRows = array();
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_text = CRM_Utils_Array::value('text', $formValues);
     $this->_table = CRM_Utils_Array::value('table', $formValues);
@@ -302,6 +305,10 @@ WHERE      t.table_name = 'Activity' AND
     CRM_Core_DAO::executeQuery($sql, $params);
   }
 
+  /**
+   * @param $tables
+   * @param $extends
+   */
   function fillCustomInfo(&$tables, $extends) {
     $sql = "
 SELECT     cg.table_name, cf.column_name
@@ -326,6 +333,9 @@ AND        cf.html_type IN ( 'Text', 'TextArea', 'RichTextEditor' )
     }
   }
 
+  /**
+   * @param $tables
+   */
   function runQueries(&$tables) {
     $sql = "TRUNCATE {$this->_entityIDTableName}";
     CRM_Core_DAO::executeQuery($sql);
@@ -701,6 +711,9 @@ WHERE      (c.sort_name LIKE {$this->_text} OR c.display_name LIKE {$this->_text
     $this->runQueries($tables);
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
     $config = CRM_Core_Config::singleton();
 
@@ -761,6 +774,9 @@ WHERE      (c.sort_name LIKE {$this->_text} OR c.display_name LIKE {$this->_text
     $this->setTitle(ts('Full-text Search'));
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     $this->_columns = array(
       ts('Contact Id') => 'contact_id',
@@ -770,6 +786,9 @@ WHERE      (c.sort_name LIKE {$this->_text} OR c.display_name LIKE {$this->_text
     return $this->_columns;
   }
 
+  /**
+   * @return array
+   */
   function summary() {
     $this->initialize();
 
@@ -827,6 +846,9 @@ WHERE      (c.sort_name LIKE {$this->_text} OR c.display_name LIKE {$this->_text
     return $summary;
   }
 
+  /**
+   * @return null|string
+   */
   function count() {
     $this->initialize();
 
@@ -838,6 +860,14 @@ WHERE      (c.sort_name LIKE {$this->_text} OR c.display_name LIKE {$this->_text
     }
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $returnSQL
+   *
+   * @return null|string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) {
     $this->initialize();
 
@@ -850,6 +880,15 @@ WHERE      (c.sort_name LIKE {$this->_text} OR c.display_name LIKE {$this->_text
     }
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL, $includeContactIDs = FALSE, $justIDs = FALSE) {
     $this->initialize();
 
@@ -871,25 +910,45 @@ FROM   {$this->_tableName} contact_a
     return $sql;
   }
 
+  /**
+   * @return null
+   */
   function from() {
     return NULL;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return null
+   */
   function where($includeContactIDs = FALSE) {
     return NULL;
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom/FullText.tpl';
   }
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     return array();
   }
 
+  /**
+   * @param $row
+   */
   function alterRow(&$row) {
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index 3b7f0a4a4d7cc0d53bf7d7a97ab6e42370822d84..2343c2d897b561e377dc01758eee6159f3df10f5 100644 (file)
@@ -45,6 +45,9 @@ class CRM_Contact_Form_Search_Custom_Group
   protected $_aclFrom = NULL;
   protected $_aclWhere = NULL;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = $formValues;
     $this->_columns = array(
@@ -87,6 +90,9 @@ class CRM_Contact_Form_Search_Custom_Group
     // in other parts after the object is destroyed
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     $this->setTitle(ts('Include / Exclude Search'));
@@ -164,6 +170,9 @@ class CRM_Contact_Form_Search_Custom_Group
   /*
    * Set search form field defaults here.
    */
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     $defaults = array( 'andOr' => '1' );
 
@@ -177,6 +186,15 @@ class CRM_Contact_Form_Search_Custom_Group
     return $defaults;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all(
     $offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
@@ -249,6 +267,10 @@ class CRM_Contact_Form_Search_Custom_Group
     return $sql;
   }
 
+  /**
+   * @return string
+   * @throws Exception
+   */
   function from() {
 
     $iGroups = $xGroups = $iTags = $xTags = 0;
@@ -547,6 +569,11 @@ WHERE  gcc.group_id = {$ssGroup->id}
     return $from;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     if ($includeContactIDs) {
       $contactIDs = array();
@@ -575,6 +602,9 @@ WHERE  gcc.group_id = {$ssGroup->id}
   /*
      * Functions below generally don't need to be modified
      */
+  /**
+   * @return mixed
+   */
   function count() {
     $sql = $this->all();
 
@@ -582,22 +612,42 @@ WHERE  gcc.group_id = {$ssGroup->id}
     return $dao->N;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $returnSQL
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) {
     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     return $this->_columns;
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom.tpl';
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
@@ -607,6 +657,9 @@ WHERE  gcc.group_id = {$ssGroup->id}
     }
   }
 
+  /**
+   * @param string $tableAlias
+   */
   function buildACLClause($tableAlias = 'contact') {
     list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias);
   }
index d8908a9bfee30f869ebf6029e42ed26f38dcc131..4e9831db0b4bdd1d05a62a355c90707cd4bb02bc 100644 (file)
@@ -38,6 +38,9 @@ class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Sea
   protected $_tables;
   protected $_options;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -88,6 +91,9 @@ class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Sea
     }
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     /**
@@ -128,10 +134,22 @@ class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Sea
     }
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL, $includeContactIDs = FALSE, $justIDs = FALSE) {
     //redirect if custom group not select in search criteria
     if (empty($this->_formValues['custom_group'])) {
@@ -168,6 +186,9 @@ contact_a.sort_name    as sort_name,
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     $from = "FROM civicrm_contact contact_a";
     $customFrom = array();
@@ -193,6 +214,11 @@ contact_a.sort_name    as sort_name,
     return $from;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $count  = 1;
     $clause = array();
@@ -238,14 +264,23 @@ contact_a.sort_name    as sort_name,
     return $this->whereClause($where, $params);
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom/MultipleValues.tpl';
   }
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     return array();
   }
 
+  /**
+   * @param $row
+   */
   function alterRow(&$row) {
     foreach ($this->_options as $fieldID => $values) {
       $customVal = $valueSeparatedArray = array();
@@ -297,6 +332,9 @@ contact_a.sort_name    as sort_name,
     }
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     CRM_Utils_System::setTitle($title);
   }
index e968fb89d50e5b600fc4b60c6875920e18d3b872..3318185728e4fb96cc8288f5c804871abf5b3c21 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Contact_Form_Search_Custom_PostalMailing extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -45,6 +48,9 @@ class CRM_Contact_Form_Search_Custom_PostalMailing extends CRM_Contact_Form_Sear
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
     $groups = array('' => ts('- select group -')) + CRM_Core_PseudoConstant::allGroup();
     $form->addElement('select', 'group_id', ts('Group'), $groups);
@@ -56,6 +62,15 @@ class CRM_Contact_Form_Search_Custom_PostalMailing extends CRM_Contact_Form_Sear
     $form->assign('elements', array('group_id'));
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
   ) {
@@ -78,6 +93,9 @@ state_province.name     as state_province
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
 FROM      civicrm_group_contact as cgc,
@@ -88,6 +106,11 @@ LEFT JOIN civicrm_state_province state_province ON  state_province.id = address.
 ";
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $params = array();
 
@@ -114,6 +137,9 @@ LEFT JOIN civicrm_state_province state_province ON  state_province.id = address.
     return $this->whereClause($where, $params);
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom.tpl';
   }
index eab0dede74d1096ccf7b1a526d157278799eb623..f648fb37309b67143830caf2ff3e811cc87c63a5 100644 (file)
@@ -39,6 +39,9 @@ class CRM_Contact_Form_Search_Custom_PriceSet extends CRM_Contact_Form_Search_Cu
   protected $_tableName = NULL;
   public $_permissionedComponent;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -151,6 +154,11 @@ WHERE participant_id = $participantID;
     }
   }
 
+  /**
+   * @param null $eventID
+   *
+   * @return Object
+   */
   function priceSetDAO($eventID = NULL) {
 
     // get all the events that have a price set associated with it
@@ -177,6 +185,11 @@ AND    p.entity_id    = e.id
     return $dao;
   }
 
+  /**
+   * @param $form
+   *
+   * @throws Exception
+   */
   function buildForm(&$form) {
     $dao = $this->priceSetDAO();
 
@@ -247,10 +260,22 @@ AND    p.entity_id    = e.id
     }
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
   ) {
@@ -279,6 +304,9 @@ contact_a.display_name   as display_name";
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
 FROM       civicrm_contact contact_a
@@ -286,20 +314,37 @@ INNER JOIN {$this->_tableName} tempTable ON ( tempTable.contact_id = contact_a.i
 ";
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     return ' ( 1 ) ';
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom.tpl';
   }
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     return array();
   }
 
+  /**
+   * @param $row
+   */
   function alterRow(&$row) {}
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index 91bc96bd490b6c54b9ea8c22adfd975707b76e69..6bf658b34e5f5a54985ed88fb81755354d9e0414 100644 (file)
@@ -38,6 +38,11 @@ class CRM_Contact_Form_Search_Custom_Proximity extends CRM_Contact_Form_Search_C
   protected $_longitude = NULL;
   protected $_distance = NULL;
 
+  /**
+   * @param $formValues
+   *
+   * @throws Exception
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -91,6 +96,9 @@ class CRM_Contact_Form_Search_Custom_Proximity extends CRM_Contact_Form_Search_C
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     $config = CRM_Core_Config::singleton();
@@ -166,6 +174,15 @@ class CRM_Contact_Form_Search_Custom_Proximity extends CRM_Contact_Form_Search_C
       ));
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
   ) {
@@ -190,6 +207,9 @@ country.name           as country
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     $f = "
 FROM      civicrm_contact contact_a
@@ -214,6 +234,11 @@ LEFT JOIN civicrm_group_contact cgc ON ( cgc.contact_id = contact_a.id AND cgc.s
     return $f;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $params = array();
     $clause = array();
@@ -240,10 +265,16 @@ AND cgc.group_id = {$this->_group}
     return $this->whereClause($where, $params);
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom/Proximity.tpl';
   }
 
+  /**
+   * @return array|null
+   */
   function setDefaultValues() {
     $config = CRM_Core_Config::singleton();
     $countryDefault = $config->defaultContactCountry;
@@ -266,8 +297,14 @@ AND cgc.group_id = {$this->_group}
     return NULL;
   }
 
+  /**
+   * @param $row
+   */
   function alterRow(&$row) {}
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index b8fe0d91792fbfb84e44d2b5bb67d7a3f14c3328..88a8508343d72404df7b90cb65c47ab11b480a48 100644 (file)
@@ -36,6 +36,9 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear
 
   protected $_debug = 0;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -70,6 +73,9 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear
     }
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
     $form->add('text',
       'segmentSize',
@@ -110,10 +116,22 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear
     $form->assign('elements', array('segmentSize', 'includeGroups', 'excludeGroups'));
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
   ) {
@@ -133,6 +151,9 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     //define table name
     $randomNum = md5(uniqid());
@@ -311,14 +332,25 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear
     return $from;
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     return '(1)';
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom.tpl';
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index e4eda144ef3c2eeeb71f47396eaa54b33ed63e36..bb8f6af6fcfdb31b59baae7b179d7a1fbed539c1 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -53,6 +56,9 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     $form->add('text',
@@ -76,6 +82,9 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust
     $form->assign('elements', array('household_name', 'state_province_id'));
   }
 
+  /**
+   * @return array
+   */
   function summary() {
     $summary = array(
       'summary' => 'This is a summary',
@@ -84,6 +93,15 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust
     return $summary;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
   ) {
@@ -105,6 +123,9 @@ state_province.name    as state_province
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
 FROM      civicrm_contact contact_a
@@ -116,6 +137,11 @@ LEFT JOIN civicrm_state_province state_province ON state_province.id = address.s
 ";
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $params = array();
     $where = "contact_a.contact_type   = 'Household'";
@@ -155,20 +181,32 @@ LEFT JOIN civicrm_state_province state_province ON state_province.id = address.s
     return $this->whereClause($where, $params);
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom.tpl';
   }
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     return array(
       'household_name' => '',
     );
   }
 
+  /**
+   * @param $row
+   */
   function alterRow(&$row) {
     $row['sort_name'] .= ' ( altered )';
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index 5c4d449b2b109b8ebce09c01e65615710d80dd8c..2b6f7399c42c0c9c05f1d7191cfa024dbd29017b 100644 (file)
@@ -37,6 +37,9 @@ class CRM_Contact_Form_Search_Custom_TagContributions implements CRM_Contact_For
   protected $_formValues;
   public $_permissionedComponent;
 
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     $this->_formValues = $formValues;
     $this->_permissionedComponent = 'CiviContribute';
@@ -54,6 +57,9 @@ class CRM_Contact_Form_Search_Custom_TagContributions implements CRM_Contact_For
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
 
     /**
@@ -136,6 +142,9 @@ WHERE  $where
     return $sql;
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
       civicrm_contribution,
@@ -150,6 +159,11 @@ WHERE  $where
   * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
   *
   */
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $clauses = array();
 
@@ -206,14 +220,27 @@ WHERE  $where
     return $dao->N;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   *
+   * @return string
+   */
   function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
   }
 
+  /**
+   * @return array
+   */
   function &columns() {
     return $this->_columns;
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
@@ -223,6 +250,9 @@ WHERE  $where
     }
   }
 
+  /**
+   * @return null
+   */
   function summary() {
     return NULL;
   }
index 312f3b1e937bc929ea6181c6e19550d62cfcfd0b..5f61345b34e7ec938953db4a863c0bf78a2f5cf7 100644 (file)
@@ -33,6 +33,9 @@
  *
  */
 class CRM_Contact_Form_Search_Custom_ZipCodeRange extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
+  /**
+   * @param $formValues
+   */
   function __construct(&$formValues) {
     parent::__construct($formValues);
 
@@ -44,6 +47,9 @@ class CRM_Contact_Form_Search_Custom_ZipCodeRange extends CRM_Contact_Form_Searc
     );
   }
 
+  /**
+   * @param $form
+   */
   function buildForm(&$form) {
     $form->add('text',
       'postal_code_low',
@@ -69,11 +75,23 @@ class CRM_Contact_Form_Search_Custom_ZipCodeRange extends CRM_Contact_Form_Searc
     $form->assign('elements', array('postal_code_low', 'postal_code_high'));
   }
 
+  /**
+   * @return array
+   */
   function summary() {
     $summary = array();
     return $summary;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
+   */
   function all($offset = 0, $rowcount = 0, $sort = NULL,
     $includeContactIDs = FALSE, $justIDs = FALSE
   ) {
@@ -94,6 +112,9 @@ address.postal_code    as postal_code
     );
   }
 
+  /**
+   * @return string
+   */
   function from() {
     return "
 FROM      civicrm_contact contact_a
@@ -104,6 +125,11 @@ LEFT JOIN civicrm_email   email   ON ( email.contact_id = contact_a.id AND
 ";
   }
 
+  /**
+   * @param bool $includeContactIDs
+   *
+   * @return string
+   */
   function where($includeContactIDs = FALSE) {
     $params = array();
 
@@ -130,14 +156,23 @@ LEFT JOIN civicrm_email   email   ON ( email.contact_id = contact_a.id AND
     return $this->whereClause($where, $params);
   }
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     return array();
   }
 
+  /**
+   * @return string
+   */
   function templateFile() {
     return 'CRM/Contact/Form/Search/Custom.tpl';
   }
 
+  /**
+   * @param $title
+   */
   function setTitle($title) {
     if ($title) {
       CRM_Utils_System::setTitle($title);
index 64a0104d7f28c13c3c75b859fa59c47768aaab2b..b9eb35da8ee05a8f880298835933f3b4b3fe92fa 100644 (file)
@@ -98,6 +98,10 @@ class CRM_Contact_Form_Task extends CRM_Core_Form {
     self::preProcessCommon($this);
   }
 
+  /**
+   * @param $form
+   * @param bool $useTable
+   */
   static function preProcessCommon(&$form, $useTable = FALSE) {
 
     $form->_contactIds = array();
index 27942090f0c662c555e7cd79e71f3ce11263b089..ec56edf08b8323f70210f953fd9afa5dedf719e3 100644 (file)
@@ -79,6 +79,12 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task {
     $this->addFormRule(array('CRM_Contact_Form_Task_AddToTag', 'formRule'));
   }
 
+  /**
+   * @param $form
+   * @param $rule
+   *
+   * @return array
+   */
   static function formRule($form, $rule) {
     $errors = array();
     if (empty($form['tag']) && empty($form['contact_taglist'])) {
index e6ec2e830753d008c84e3e4506a6e1890946c255..41eee10aa2a55033496ae3705dc9ea494476b665 100644 (file)
@@ -80,6 +80,12 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task {
     return $defaults;
   }
 
+  /**
+   * @param $form
+   * @param $rule
+   *
+   * @return array
+   */
   static function formRule($form, $rule) {
     $errors = array();
     if (empty($form['pref']) && empty($form['contact_taglist'])) {
index 279394e5016c5fe74720fce6ebc739400875922d..acd679f655d6a2d0f52ade7f2e4cbd8a3bcd218e 100644 (file)
@@ -45,6 +45,9 @@ class CRM_Contact_Form_Task_EmailCommon {
   public $_allContactDetails = array();
   public $_toContactEmails = array();
 
+  /**
+   * @param $form
+   */
   static function preProcessFromAddress(&$form) {
     $form->_single = FALSE;
     $className = CRM_Utils_System::getClassName($form);
index e036741723a49292f389ec15b1f42871254997ac..5826bcf16333789135699efcff2281bfb0c9865c 100644 (file)
@@ -429,6 +429,9 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task {
     return $returnProperties;
   }
 
+  /**
+   * @param $rows
+   */
   function mergeSameAddress(&$rows) {
     $uniqueAddress = array();
     foreach (array_keys($rows) as $rowID) {
index de287247993ab475b9735887d375715bd61d1e58..5e72b241886947d9e19d859a16a119d598cf9ae6 100644 (file)
@@ -389,6 +389,11 @@ class CRM_Contact_Form_Task_LabelCommon {
     }
   }
 
+  /**
+   * @param $rows
+   *
+   * @return array
+   */
   function mergeSameHousehold(&$rows) {
     # group selected contacts by type
     $individuals = array();
index 441b461bd89f274a729082d3ec5320ee54809377..bca9f0bb754d0817d517062f04f88763a2af02f5 100644 (file)
@@ -59,6 +59,15 @@ class CRM_Contact_Form_Task_Map_Event extends CRM_Contact_Form_Task_Map {
     $this->assign('skipLocationType', TRUE);
   }
 
+  /**
+   * Use the form name to create the tpl file name
+   *
+   * @return string
+   * @access public
+   */
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
     return 'CRM/Contact/Form/Task/Map.tpl';
   }
index 7a8e12c164f4e9801fda2ba36de7c6caa2817726..9686b0ced63a348817ec2a54b6e95f79dd409914 100644 (file)
@@ -87,6 +87,17 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task {
     $this->assign('single', $this->_single);
   }
 
+  /**
+   * This function sets the default values for the form. Relationship that in edit/view action
+   * the default values are retrieved from the database
+   *
+   * @access public
+   *
+   * @return void
+   */
+  /**
+   *
+   */
   function setDefaultValues() {
     $defaults = array();
     if (isset($this->_activityId)) {
index de6b300d5dddf3ae089ffffcbd50631b7c687474..5127d365d14e510132beda06af9c916b47175e25 100644 (file)
@@ -63,6 +63,10 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
     CRM_Utils_System::setTitle('Create Printable Letters (PDF)');
   }
 
+  /**
+   * @param $form
+   * @param $cid
+   */
   static function preProcessSingle(&$form, $cid) {
     $form->_contactIds = array($cid);
     // put contact display name in title for single contact mode
@@ -382,6 +386,13 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
     CRM_Utils_System::civiExit(1);
   }
 
+  /**
+   * @param $form
+   * @param $html_message
+   * @param $contactIds
+   *
+   * @throws CRM_Core_Exception
+   */
   static function createActivities($form, $html_message, $contactIds) {
     //Added for CRM-12682: Add activity subject and campaign fields
     $formValues     = $form->controller->exportValues($form->getName());
@@ -430,6 +441,9 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
     }
   }
 
+  /**
+   * @param $message
+   */
   static function formatMessage(&$message) {
     $newLineOperators = array(
       'p' => array(
index 863494c2952b6b26f0fe4f11627def32acf8f51d..6c4f5060182f41c3cb0ef978f1ac74674a63e7ad 100644 (file)
@@ -76,6 +76,12 @@ class CRM_Contact_Form_Task_RemoveFromTag extends CRM_Contact_Form_Task {
     $this->addFormRule(array('CRM_Contact_Form_Task_RemoveFromTag', 'formRule'));
   }
 
+  /**
+   * @param $form
+   * @param $rule
+   *
+   * @return array
+   */
   static function formRule($form, $rule) {
     $errors = array();
     if (empty($form['tag']) && empty($form['contact_taglist'])) {
index 8d32a98aabdd97d4c4de0ad73499aae36648a3e5..b632b1566980825407490ecf8b99df9a95e4c0c7 100644 (file)
@@ -47,6 +47,9 @@ class CRM_Contact_Form_Task_SMSCommon {
   public $_toContactPhone = array();
 
 
+  /**
+   * @param $form
+   */
   static function preProcessProvider(&$form) {
     $form->_single = FALSE;
     $className = CRM_Utils_System::getClassName($form);
index c3b4ad1df2b8a0030a5cac0d8948995e2eeaca9e..cc98b573af40f8ab314776d718fd7a2f100def09 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Contact_Form_Task_Unhold
+ */
 class CRM_Contact_Form_Task_Unhold extends CRM_Contact_Form_Task {
 
   /**
index 1b274d6b970380b836c67d3ed6f5ee979f6cdb7c..247ad9863384e3b6c4d9034d1711b9a4330146ec 100644 (file)
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
 */
+
+/**
+ * Class CRM_Contact_Import_Field
+ */
 class CRM_Contact_Import_Field {
 
   /**#@+
@@ -125,6 +129,20 @@ class CRM_Contact_Import_Field {
    */
   public $_relatedContactPhoneType;
 
+  /**
+   * @param $name
+   * @param $title
+   * @param int $type
+   * @param string $columnPattern
+   * @param string $dataPattern
+   * @param null $hasLocationType
+   * @param null $phoneType
+   * @param null $related
+   * @param null $relatedContactType
+   * @param null $relatedContactDetails
+   * @param null $relatedContactLocType
+   * @param null $relatedContactPhoneType
+   */
   function __construct($name, $title, $type = CRM_Utils_Type::T_INT, $columnPattern = '//', $dataPattern = '//', $hasLocationType = NULL, $phoneType = NULL, $related = NULL, $relatedContactType = NULL, $relatedContactDetails = NULL, $relatedContactLocType = NULL, $relatedContactPhoneType = NULL) {
     $this->_name = $name;
     $this->_title = $title;
@@ -154,6 +172,9 @@ class CRM_Contact_Import_Field {
     $this->_value = $value;
   }
 
+  /**
+   * @return bool
+   */
   function validate() {
     //  echo $this->_value."===========<br>";
     $message = '';
index a31e5086ed243e0c3b8f73cab0b8510f298507f5..93196eb5487c6c3f606d2cf8375a5cbbf89356ec 100644 (file)
@@ -227,6 +227,18 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form {
     );
   }
 
+  /**
+   * This virtual function is used to set the default values of
+   * various form elements
+   *
+   * access        public
+   *
+   * @return array reference to the array of default values
+   *
+   */
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     $config = CRM_Core_Config::singleton();
     $defaults = array(
@@ -244,6 +256,10 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form {
     return $defaults;
   }
 
+  /**
+   * @return array
+   * @throws Exception
+   */
   private function _getDataSources() {
     // Open the data source dir and scan it for class files
     $config        = CRM_Core_Config::singleton();
index f633c2c75c844b1af9889fc8854cece50bb7a9c8..3d45cacd2c88ea0be3c15e736016825736bb10f9 100644 (file)
@@ -73,6 +73,13 @@ class CRM_Contact_Import_ImportJob {
 
   protected $_parser;
 
+  /**
+   * @param null $tableName
+   * @param null $createSql
+   * @param bool $createTable
+   *
+   * @throws Exception
+   */
   public function __construct($tableName = NULL, $createSql = NULL, $createTable = FALSE) {
     $dao = new CRM_Core_DAO();
     $db = $dao->getDatabaseConnection();
@@ -114,10 +121,19 @@ class CRM_Contact_Import_ImportJob {
     foreach ($properties as $property) $this->{"_$property"} = array();
   }
 
+  /**
+   * @return null|string
+   */
   public function getTableName() {
     return $this->_tableName;
   }
 
+  /**
+   * @param bool $dropIfComplete
+   *
+   * @return bool
+   * @throws Exception
+   */
   public function isComplete($dropIfComplete = TRUE) {
     if (!$this->_statusFieldName) {
       CRM_Core_Error::fatal("Could not get name of the import status field");
@@ -135,6 +151,9 @@ class CRM_Contact_Import_ImportJob {
     return TRUE;
   }
 
+  /**
+   * @param $params
+   */
   public function setJobParams(&$params) {
     foreach ($params as $param => $value) {
       $fldName = "_$param";
@@ -142,6 +161,10 @@ class CRM_Contact_Import_ImportJob {
     }
   }
 
+  /**
+   * @param $form
+   * @param int $timeout
+   */
   public function runImport(&$form, $timeout = 55) {
     $mapper        = $this->_mapper;
     $mapperFields  = array();
@@ -307,10 +330,20 @@ class CRM_Contact_Import_ImportJob {
     }
   }
 
+  /**
+   * @param $form
+   */
   public function setFormVariables($form) {
     $this->_parser->set($form, CRM_Import_Parser::MODE_IMPORT);
   }
 
+  /**
+   * @param $contactIds
+   * @param $newGroupName
+   * @param $newGroupDesc
+   *
+   * @return array|bool
+   */
   private function _addImportedContactsToNewGroup($contactIds,
     $newGroupName, $newGroupDesc
   ) {
@@ -357,6 +390,13 @@ class CRM_Contact_Import_ImportJob {
     return FALSE;
   }
 
+  /**
+   * @param $contactIds
+   * @param $newTagName
+   * @param $newTagDesc
+   *
+   * @return array|bool
+   */
   private function _tagImportedContactsWithNewTag($contactIds,
     $newTagName, $newTagDesc
   ) {
@@ -406,6 +446,9 @@ class CRM_Contact_Import_ImportJob {
     return FALSE;
   }
 
+  /**
+   * @return array
+   */
   public static function getIncompleteImportTables() {
     $dao      = new CRM_Core_DAO();
     $database = $dao->database();
index 72e4bcbda4470b23f5d047f96960e97072c57eb5..32931fd6c4afd5e98d051c13a0eedae590a8d768 100644 (file)
  *  via a form post) and asynchronously (i.e. by the workflow system)
  */
 class CRM_Contact_Import_Importer {
+  /**
+   *
+   */
   public function __construct() {
     // may not need this
   }
 
+  /**
+   * @param int $timeout
+   */
   public function runIncompleteImportJobs($timeout = 55) {
     $startTime = time();
     $incompleteImportTables = CRM_Contact_Import_ImportJob::getIncompleteImportTables();
index 16de2f41525e172a6576d2490ba3bee40e6162a0..9f3b8704f35191de9bffad1c5c960b915aa7ffd6 100644 (file)
@@ -87,6 +87,23 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
    */
   public $_dedupeRuleGroupID = NULL;
 
+  /**
+   * @param $tableName
+   * @param $mapper
+   * @param int $mode
+   * @param int $contactType
+   * @param string $primaryKeyName
+   * @param string $statusFieldName
+   * @param int $onDuplicate
+   * @param null $statusID
+   * @param null $totalRowCount
+   * @param bool $doGeocodeAddress
+   * @param int $timeout
+   * @param null $contactSubType
+   * @param null $dedupeRuleGroupID
+   *
+   * @return mixed
+   */
   function run($tableName,
     &$mapper,
     $mode = self::MODE_PREVIEW,
@@ -403,18 +420,30 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldLocationTypes($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_hasLocationType = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
+  /**
+   * @param $elements
+   */
   function setActiveFieldPhoneTypes($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_phoneType = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldWebsiteTypes($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_websiteType = $elements[$i];
@@ -435,36 +464,54 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldRelated($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_related = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldRelatedContactType($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_relatedContactType = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldRelatedContactDetails($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_relatedContactDetails = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldRelatedContactLocType($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_relatedContactLocType = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldRelatedContactPhoneType($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_relatedContactPhoneType = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldRelatedContactWebsiteType($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_relatedContactWebsiteType = $elements[$i];
@@ -585,6 +632,9 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
     return $params;
   }
 
+  /**
+   * @return array
+   */
   function getColumnPatterns() {
     $values = array();
     foreach ($this->_fields as $name => $field) {
@@ -593,6 +643,14 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
     return $values;
   }
 
+  /**
+   * @param $name
+   * @param $title
+   * @param int $type
+   * @param string $headerPattern
+   * @param string $dataPattern
+   * @param bool $hasLocationType
+   */
   function addField($name, $title, $type = CRM_Utils_Type::T_INT,
     $headerPattern = '//', $dataPattern = '//',
     $hasLocationType = FALSE
index cf4a173f22454f36980adae3a195ac7982f25fb3..e582fb219082405deadd5649092cc13c04e97d9a 100644 (file)
@@ -2081,6 +2081,12 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser {
     return $returnCode;
   }
 
+  /**
+   * @param $relKey
+   * @param $params
+   *
+   * @return bool
+   */
   function checkRelatedContactFields($relKey, $params) {
     //avoid blank contact creation.
     $allowToCreate = FALSE;
index a7e38b0b15399444d444beda9ca9676209c8b624..7cda6262c21186fe1fa2613cc0b1ece170b24481 100644 (file)
@@ -320,6 +320,12 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se
   }
   //end of function
 
+  /**
+   * @param null $action
+   * @param null $output
+   *
+   * @return array
+   */
   function &getColHeads($action = NULL, $output = NULL) {
     $colHeads = self::_getColumnHeaders();
     $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
@@ -818,6 +824,11 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se
     return $rows;
   }
 
+  /**
+   * @param $sort
+   *
+   * @return string
+   */
   function buildPrevNextCache($sort) {
     $cacheKey = 'civicrm search ' . $this->_key;
 
@@ -849,6 +860,9 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se
     return $cacheKey;
   }
 
+  /**
+   * @param $rows
+   */
   function addActions(&$rows) {
     $config = CRM_Core_Config::singleton();
 
@@ -941,6 +955,9 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se
     }
   }
 
+  /**
+   * @param $rows
+   */
   function removeActions(&$rows) {
     foreach ($rows as $rid => & $rValue) {
       unset($rValue['contact_type']);
@@ -1130,14 +1147,29 @@ SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.dis
     return self::$_columnHeaders;
   }
 
+  /**
+   * @return CRM_Contact_BAO_Query
+   */
   function &getQuery() {
     return $this->_query;
   }
 
+  /**
+   * @return CRM_Contact_DAO_Contact
+   */
   function alphabetQuery() {
     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
   }
 
+  /**
+   * @param $params
+   * @param $action
+   * @param $sortID
+   * @param null $displayRelationshipType
+   * @param string $queryOperator
+   *
+   * @return CRM_Contact_DAO_Contact
+   */
   function contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
     $sortOrder = &$this->getSortOrder($this->_action);
     $sort = new CRM_Utils_Sort($sortOrder, $sortID);
@@ -1170,6 +1202,11 @@ SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.dis
     return $value;
   }
 
+  /**
+   * @param $returnProperties
+   *
+   * @return array
+   */
   function &makeProperties(&$returnProperties) {
     $properties = array();
     foreach ($returnProperties as $name => $value) {
index 94a3b9e56c4d6f7be0a0d562560f86765c5a80c4..9e078655e803231214a06959fb9651e943c4647d 100644 (file)
  *
  */
 class CRM_Contact_Selector_Controller extends CRM_Core_Selector_Controller {
+  /**
+   * default function for qill, if needed to be implemented, we
+   * expect the subclass to do it
+   *
+   * @return string the status message
+   * @access public
+   */
+  /**
+   * @return string
+   */
   function getQill() {
     return $this->_object->getQILL();
   }
index 6ddea8213c211374892188c0497b6b48e2404bf3..d5fc147ba199b77b8f24a473ba738ba65826e866 100644 (file)
@@ -383,6 +383,9 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     return NULL;
   }
 
+  /**
+   * @return mixed
+   */
   public function getSummary() {
     return $this->_search->summary();
   }
@@ -398,10 +401,22 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     return ts('CiviCRM Custom Search');
   }
 
+  /**
+   * @return null
+   */
   function alphabetQuery() {
     return NULL;
   }
 
+  /**
+   * @param $params
+   * @param $action
+   * @param $sortID
+   * @param null $displayRelationshipType
+   * @param string $queryOperator
+   *
+   * @return Object
+   */
   function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
     $params = array();
     $sql = $this->_search->contactIDs($params);
@@ -409,6 +424,9 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     return CRM_Core_DAO::executeQuery($sql, $params);
   }
 
+  /**
+   * @param $rows
+   */
   function addActions(&$rows) {
     $links = self::links();
 
@@ -431,6 +449,9 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     }
   }
 
+  /**
+   * @param $rows
+   */
   function removeActions(&$rows) {
     foreach ($rows as $rid => & $rValue) {
       unset($rValue['action']);
index 5c7f45be679da9118bd8bc14f7f3826fb1c0c4f2..85b387e440155c7c48c6db923a1a5758ebfbb774 100644 (file)
@@ -369,6 +369,11 @@ class CRM_Contact_Task {
     return $tasks;
   }
 
+  /**
+   * @param $value
+   *
+   * @return array
+   */
   static function getTask($value) {
     self::initTasks();