Commit 100fef9d authored by colemanw's avatar colemanw

Cleanup phpdoc comments

parent 1fa961e3
......@@ -47,7 +47,7 @@ class CRM_ACL_API {
CONST ALL = 6;
/**
* given a permission string, check for access requirements
* Given a permission string, check for access requirements
*
* @param string $str the permission to check
* @param int $contactID the contactID for whom the check is made
......@@ -135,7 +135,7 @@ class CRM_ACL_API {
}
/**
* get all the groups the user has access to for the given operation
* Get all the groups the user has access to for the given operation
*
* @param int $type the type of permission needed
* @param int $contactID the contactID for whom the check is made
......@@ -168,10 +168,10 @@ class CRM_ACL_API {
}
/**
* check if the user has access to this group for operation $type
* Check if the user has access to this group for operation $type
*
* @param int $type the type of permission needed
* @param $groupID
* @param int $groupID
* @param int $contactID the contactID for whom the check is made
*
* @param string $tableName
......
......@@ -674,7 +674,7 @@ SELECT $acl.*
}
/**
* update the is_active flag in the db
* Update the is_active flag in the db
*
* @param int $id id of the database record
* @param boolean $is_active value we want to set the is_active field
......@@ -691,7 +691,7 @@ SELECT $acl.*
/**
* @param $str
* @param $contactID
* @param int $contactID
*
* @return bool
*/
......@@ -725,7 +725,7 @@ SELECT count( a.id )
* @param $type
* @param $tables
* @param $whereTables
* @param null $contactID
* @param int $contactID
*
* @return null|string
*/
......@@ -847,7 +847,7 @@ SELECT g.*
/**
* @param int $type
* @param null $contactID
* @param int $contactID
* @param string $tableName
* @param null $allGroups
* @param null $includedGroups
......@@ -963,7 +963,7 @@ ORDER BY a.object_id
}
/**
* delete ACL records
* Delete ACL records
*
* @param int $aclId ID of the ACL record to be deleted.
*
......
......@@ -41,7 +41,7 @@ class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache {
static $_cache = NULL;
/**
* @param $id
* @param int $id
*
* @return mixed
*/
......@@ -67,7 +67,7 @@ class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache {
}
/**
* @param $id
* @param int $id
*
* @return array
*/
......@@ -93,8 +93,8 @@ SELECT acl_id
}
/**
* @param $id
* @param $cache
* @param int $id
* @param array $cache
*/
static function store($id, &$cache) {
foreach ($cache as $aclID => $data) {
......@@ -111,7 +111,7 @@ SELECT acl_id
}
/**
* @param $id
* @param int $id
*/
static function deleteEntry($id) {
if (self::$_cache &&
......@@ -129,7 +129,7 @@ WHERE contact_id = %1
}
/**
* @param $id
* @param int $id
*/
static function updateEntry($id) {
// rebuilds civicrm_acl_cache
......
......@@ -73,7 +73,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
}
/**
* update the is_active flag in the db
* Update the is_active flag in the db
*
* @param int $id id of the database record
* @param boolean $is_active value we want to set the is_active field
......@@ -86,7 +86,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
}
/**
* delete Entity Role records
* Delete Entity Role records
*
* @param int $entityRoleId ID of the EntityRole record to be deleted.
*
......
......@@ -40,7 +40,7 @@
class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
/**
* static field for all the activity information that we can potentially export
* Static field for all the activity information that we can potentially export
*
* @var array
* @static
......@@ -48,7 +48,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
static $_exportableFields = NULL;
/**
* static field for all the activity information that we can potentially import
* Static field for all the activity information that we can potentially import
*
* @var array
* @static
......@@ -76,7 +76,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $defaults (reference ) an assoc array to hold the flattened values
*
* @return CRM_Core_BAO_Meeting object
* @return CRM_Activity_DAO_Activity object
* @access public
*/
public static function retrieve(&$params, &$defaults) {
......@@ -140,7 +140,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
}
/**
* delete the activity
* Delete the activity
*
* @param array $params associated array
* @param bool $moveToTrash
......@@ -250,7 +250,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
* Delete activity assignment record
*
* @param int $activityId
* @param null $recordTypeID
* @param int $recordTypeID
*
* @return null
* @access public
......@@ -265,7 +265,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
}
/**
* process the activities
* Process the activities
*
* @param array $params associated array of the submitted values
*
......@@ -643,7 +643,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
}
/**
* get the list Activities
* Get the list Activities
*
* @param array $input array of parameters
* Keys include
......@@ -935,7 +935,7 @@ ORDER BY fixed_sort_order
}
/**
* get the activity Count
* Get the activity Count
*
* @param array $input array of parameters
* Keys include
......@@ -971,7 +971,7 @@ LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.a
}
/**
* function to get the activity sql clause to pick activities
* Get the activity sql clause to pick activities
*
* @param array $input array of parameters
* Keys include
......@@ -1151,7 +1151,7 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* send the message to all the contacts and also insert a
* Send the message to all the contacts and also insert a
* contact activity in each contacts record
*
* @param array $contactDetails the array of contact details to send the email
......@@ -1355,11 +1355,11 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* @param $contactDetails
* @param $activityParams
* @param array $contactDetails
* @param array $activityParams
* @param array $smsParams
* @param $contactIds
* @param null $userID
* @param int $userID
*
* @return array
* @throws CRM_Core_Exception
......@@ -1498,14 +1498,14 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* send the sms message to a specific contact
* Send the sms message to a specific contact
*
* @param int $toID the contact id of the recipient
* @param $tokenText
* @param $tokenHtml
* @param array $smsParams the params used for sending sms
* @param int $activityID the activity ID that tracks the message
* @param null $userID
* @param int $userID
*
* @return mixed true on success or PEAR_Error object
* @access public
......@@ -1573,10 +1573,10 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* send the message to a specific contact
* Send the message to a specific contact
*
* @param string $from the name and email of the sender
* @param $fromID
* @param int $fromID
* @param int $toID the contact id of the recipient
* @param string $subject the subject of the message
* @param $text_message
......@@ -1651,7 +1651,7 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* combine all the importable fields from the lower levels object
* Combine all the importable fields from the lower levels object
*
* The ordering is important, since currently we do not have a weight
* scheme. Adding weight is super important and should be done in the
......@@ -1782,7 +1782,7 @@ WHERE activity.id IN ($activityIds)";
}
/**
* Function to add activity for Membership/Event/Contribution
* Add activity for Membership/Event/Contribution
*
* @param object $activity (reference) particular component object
* @param string $activityType for Membership Signup or Renewal
......@@ -2014,11 +2014,11 @@ AND cl.modified_id = c.id
}
/**
* Function to find the latest revision of a given activity
* Find the latest revision of a given activity
*
* @param $activityID prior activity id
* @param int $activityID prior activity id
*
* @return int $params current activity id.
* @return int current activity id.
* @access public
*/
static function getLatestActivityId($activityID) {
......@@ -2046,7 +2046,7 @@ AND cl.modified_id = c.id
}
/**
* Function to create a follow up a given activity
* Create a follow up a given activity
*
* @param $activityId int activity id of parent activity
* @param array $params
......@@ -2086,7 +2086,7 @@ AND cl.modified_id = c.id
}
/**
* Function to get Activity specific File according activity type Id.
* Get Activity specific File according activity type Id.
*
* @param int $activityTypeId activity id
* @param string $crmDir
......@@ -2120,7 +2120,7 @@ AND cl.modified_id = c.id
}
/**
* Function to restore the activity
* Restore the activity
*
* @param array $params associated array
*
......@@ -2620,8 +2620,8 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n
}
/**
* @param $activityId
* @param null $recordTypeID
* @param int $activityId
* @param int $recordTypeID
* @param string $column
*
* @return null
......@@ -2639,7 +2639,7 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n
}
/**
* @param $activityId
* @param int $activityId
*
* @return null
*/
......
......@@ -40,7 +40,7 @@
class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityContact {
/**
* class constructor
* Class constructor
*/
function __construct() {
parent::__construct();
......
......@@ -40,14 +40,14 @@
class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact {
/**
* class constructor
* Class constructor
*/
function __construct() {
parent::__construct();
}
/**
* funtion to add activity contact
* Funtion to add activity contact
*
* @param array $params the values for this table: activity id, contact id, record type
*
......@@ -66,7 +66,7 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact
}
/**
* retrieve names of contact by activity_id
* Retrieve names of contact by activity_id
*
* @param int $activityID
* @param int $recordTypeID
......@@ -107,10 +107,10 @@ AND contact_a.is_deleted = 0
}
/**
* retrieve id of target contact by activity_id
* Retrieve id of target contact by activity_id
*
* @param $activityID
* @param $recordTypeID
* @param int $activityID
* @param int $recordTypeID
*
* @return mixed
*
......
......@@ -40,14 +40,14 @@
class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact {
/**
* class constructor
* Class constructor
*/
function __construct() {
parent::__construct();
}
/**
* add activity target
* Add activity target
*
* @param array $params
*
......@@ -65,7 +65,7 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact {
}
/**
* retrieve id of target contact by activity_id
* Retrieve id of target contact by activity_id
*
* @param int $activity_id
*
......@@ -98,7 +98,7 @@ AND civicrm_contact.is_deleted = 0
}
/**
* retrieve names of target contact by activity_id
* Retrieve names of target contact by activity_id
*
* @param int $activityID
*
......
......@@ -36,7 +36,7 @@
class CRM_Activity_BAO_Query {
/**
* build select for Case
* Build select for Case
*
* @param $query
*
......@@ -183,7 +183,7 @@ class CRM_Activity_BAO_Query {
}
/**
* where clause for a single field
* Where clause for a single field
*
* @param $values
* @param $query
......@@ -395,7 +395,7 @@ class CRM_Activity_BAO_Query {
}
/**
* @param $name
* @param string $name
* @param $mode
* @param $side
*
......@@ -452,7 +452,7 @@ class CRM_Activity_BAO_Query {
}
/**
* getter for the qill object
* Getter for the qill object
*
* @return string
* @access public
......@@ -462,11 +462,11 @@ class CRM_Activity_BAO_Query {
}
/**
* add all the elements shared between case activity search and advanaced search
* Add all the elements shared between case activity search and advanced search
*
* @access public
*
* @param $form CRM_Core_Form
* @param CRM_Core_Form $form
* @return void
* @static
*/
......
......@@ -46,7 +46,7 @@
class CRM_Activity_Controller_Search extends CRM_Core_Controller {
/**
* class constructor
* Class constructor
*/
function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) {
......
......@@ -47,7 +47,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
public $_activityId;
/**
* store activity ids when multiple activities are created
* Store activity ids when multiple activities are created
*
* @var int
*/
......@@ -816,7 +816,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
}
/**
* global form rule
* Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
......@@ -867,8 +867,8 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
*
* @access public
*
* @param null $params
* @return void
* @param array $params
* @return array|null
*/
public function postProcess($params = NULL) {
if ($this->_action & CRM_Core_Action::DELETE) {
......@@ -1165,9 +1165,10 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
}
/**
* let injecting activity type file do any processing
* Let injecting activity type file do any processing
* needed, before the activity is added/updated
*
* @param array $params
*/
function beginPostProcess(&$params) {
if ($this->_activityTypeFile) {
......@@ -1177,14 +1178,16 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
}
/**
* let injecting activity type file do any processing
* Let injecting activity type file do any processing
* needed, after the activity has been added/updated
*
* @param array $params
* @param $activity
*/
function endPostProcess(&$params, &$activity) {
if ($this->_activityTypeFile) {
$className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
$className::endPostProcess($this, $params, $activity );
$className::endPostProcess($this, $params, $activity);
}
}
}
......
......@@ -40,7 +40,7 @@
class CRM_Activity_Form_ActivityView extends CRM_Core_Form {
/**
* set variables up before form is built
* Set variables up before form is built
*
* @return void
* @access public
......
......@@ -42,7 +42,7 @@
class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
/**
* the params that are sent to the query
* The params that are sent to the query
*
* @var array
* @access protected
......@@ -50,7 +50,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
protected $_queryParams;
/**
* are we restricting ourselves to a single contact
* Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
......@@ -58,7 +58,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
protected $_single = FALSE;
/**
* are we restricting ourselves to a single contact
* Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
......@@ -66,7 +66,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
protected $_limit = NULL;
/**
* prefix for the controller
* Prefix for the controller
*
*/
protected $_prefix = "activity_";
......@@ -74,7 +74,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
protected $_defaults;
/**
* the saved search ID retrieved from the GET vars
* The saved search ID retrieved from the GET vars
*
* @var int
* @access protected
......@@ -82,7 +82,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
protected $_ssID;
/**
* processing needed for buildForm and later
* Processing needed for buildForm and later
*
* @return void
* @access public
......
......@@ -40,7 +40,7 @@
class CRM_Activity_Form_Task extends CRM_Core_Form {
/**
* the task being performed
* The task being performed
*
* @var int
*/
......@@ -75,7 +75,7 @@ class CRM_Activity_Form_Task extends CRM_Core_Form {
public $_activityHolderIds;
/**
* build all the data structures needed to build the form
* Build all the data structures needed to build the form
*
* @param
*
......@@ -172,7 +172,7 @@ WHERE activity_id IN ( $IDs ) AND
}
/**
* simple shell that derived classes can call to add buttons to
* Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit