* @package CRM
* @copyright CiviCRM LLC (c) 2004-2014
* $Id$
- *
*/
/**
- * This class is for activity functions
- *
+ * This class is for activity functions.s
*/
class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
static $_importableFields = NULL;
/**
- * Check if there is absolute minimum of data to add the object
+ * Check if there is absolute minimum of data to add the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete the activity
+ * Delete the activity.
*
* @param array $params
* @param bool $moveToTrash
*
- * @return void
+ * @return mixed
*/
public static function deleteActivity(&$params, $moveToTrash = FALSE) {
// CRM-9137
}
/**
- * Delete activity assignment record
+ * Delete activity assignment record.
*
* @param int $activityId
* @param int $recordTypeID
}
/**
- * Process the activities
+ * Process the activities.
*
* @param array $params
* Associated array of the submitted values.
}
/**
- * @param $activity
- * @param null $logMessage
+ * Create an activity.
+ *
+ * @todo elaborate on what this does.
+ *
+ * @param CRM_Core_DAO_Activity $activity
+ * @param string $logMessage
*
* @return bool
*/
}
/**
- * Get the list Activities
+ * Get the list Activities.
*
* @param array $input
* Array of parameters.
* - activity_type_id int|string the activitiy types we want to restrict by
*
* @return array
- * (reference) $values the relevant data object values of open activities
- *
+ * Relevant data object values of open activities
*/
public static function &getActivities($input) {
//step 1: Get the basic activity data
}
/**
- * Get the component id and name those are enabled and logged in
- * user has permission. To decide whether we are going to include
- * component related activities w/ core activity retrieve process.
+ * Get the component id and name if those are enabled and allowed.
+ *
+ * Checks whether logged in user has permission.
+ * To decide whether we are going to include
+ * component related activities with core activity retrieve process.
+ * (what did that just mean?)
*
* @return array
* Array of component id and name.
}
/**
- * Get the activity Count
+ * Get the activity Count.
*
* @param array $input
* Array of parameters.
*
* @return int
* count of activities
- *
*/
public static function &getActivitiesCount($input) {
$input['count'] = TRUE;
}
/**
- * Get the activity sql clause to pick activities
+ * Get the activity sql clause to pick activities.
*
* @param array $input
* Array of parameters.
*
* @return int
* count of activities
- *
*/
public static function getActivitySQLClause($input) {
$params = array();
}
/**
- * Send the message to all the contacts and also insert a
- * contact activity in each contacts record
+ * Send the message to all the contacts.
+ *
+ * Also insert a contact activity in each contacts record.
*
* @param array $contactDetails
* The array of contact details to send the email.
$attachments = NULL,
$cc = NULL,
$bcc = NULL,
- $contactIds, // FIXME a param with no default shouldn't be last
+ // FIXME a param with no default shouldn't be last
+ $contactIds,
$additionalDetails = NULL
) {
// get the contact details of logged in contact, which we set as from email
}
/**
+ * Send SMS.
+ *
* @param array $contactDetails
* @param array $activityParams
* @param array $smsParams
}
/**
- * 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
}
/**
- * Send the message to a specific contact
+ * Send the message to a specific contact.
*
* @param string $from
* The name and email of the sender.
}
/**
- * 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
}
/**
- * get the Activities of a target contact
+ * Get the Activities of a target contact.
*
* @param int $contactId
* Id of the contact whose activities need to find.
}
/**
- * Add activity for Membership/Event/Contribution
+ * Add activity for Membership/Event/Contribution.
*
* @param object $activity
* (reference) particular component object.
}
/**
- * Get Parent activity for currently viewed activity
+ * Get Parent activity for currently viewed activity.
*
* @param int $activityId
* Current activity id.
*
* @return int
- * $parentId Id of parent activity otherwise false.
+ * Id of parent activity otherwise false.
*/
public static function getParentActivity($activityId) {
static $parentActivities = array();
}
/**
- * Get total count of prior revision of currently viewd activity
+ * Get total count of prior revision of currently viewed activity.
*
* @param $activityID
* Current activity id.
}
/**
- * Get all prior activities of currently viewed activity
+ * Get all prior activities of currently viewed activity.
*
* @param $activityID
* Current activity id.
}
/**
- * Find the latest revision of a given activity
+ * Find the latest revision of a given activity.
*
* @param int $activityID
* Prior activity id.
}
/**
- * Create a follow up a given activity
+ * Create a follow up a given activity.
*
* @param int $activityId
* activity id of parent activity.
*
* @return string|bool
* if file exists returns $activityTypeFile activity filename otherwise false.
- *
*/
public static function getFileForActivityTypeId($activityTypeId, $crmDir = 'Activity') {
$activityTypes = CRM_Case_PseudoConstant::caseActivityType(FALSE, TRUE);
}
/**
- * Restore the activity
+ * Restore the activity.
*
* @param array $params
*
- * @return void
+ * @return CRM_Activity_DAO_Activity
*/
public static function restoreActivity(&$params) {
$activity = new CRM_Activity_DAO_Activity();
}
/**
- * Get the exportable fields for Activities
+ * Get the exportable fields for Activities.
*
* @param string $name
* If it is called by case $name = Case else $name = Activity.
);
$Activityfields = array(
- 'activity_type' => array('title' => ts('Activity Type'), 'name' => 'activity_type', 'type' => CRM_Utils_Type::T_STRING),
- 'activity_status' => array('title' => ts('Activity Status'), 'name' => 'activity_status', 'type' => CRM_Utils_Type::T_STRING),
+ 'activity_type' => array(
+ 'title' => ts('Activity Type'),
+ 'name' => 'activity_type',
+ 'type' => CRM_Utils_Type::T_STRING,
+ ),
+ 'activity_status' => array(
+ 'title' => ts('Activity Status'),
+ 'name' => 'activity_status',
+ 'type' => CRM_Utils_Type::T_STRING,
+ ),
);
$fields = array_merge($Activityfields, $exportableFields);
}
}
/**
- * Get the allowed profile fields for Activities
+ * Get the allowed profile fields for Activities.
*
* @return array
* array of activity profile Fields
}
/**
- * This function deletes the activity record related to contact record,
- * when there are no target and assignee record w/ other contact.
+ * This function deletes the activity record related to contact record.
+ *
+ * This is conditional on there being no target and assignee record
+ * with other contacts.
*
* @param int $contactId
* ContactId.
}
/**
- * Does user has sufficient permission for view/edit activity record?
+ * Does user has sufficient permission for view/edit activity record.
*
* @param int $activityId
* Activity record id.
}
/**
- * wrapper for ajax activity selector
+ * Wrapper for ajax activity selector.
*
* @param array $params
* Associated array for params record id.
*
* @return array
- * associated array of contact activities
+ * Associated array of contact activities
*/
public static function getContactActivitySelector(&$params) {
// format the params
}
/**
- * copy custom fields and attachments from an existing activity to another.
+ * Copy custom fields and attachments from an existing activity to another.
+ *
* @see CRM_Case_Page_AJAX::_convertToCaseActivity()
*
* @param array $params
}
/**
+ * Get activity contact.
+ *
* @param int $activityId
* @param int $recordTypeID
* @param string $column
}
/**
+ * Get source contact id.
+ *
* @param int $activityId
*
* @return null
}
/**
+ * Set api filter.
+ *
+ * @todo Document what this is for.
+ *
* @param array $params
*/
public function setApiFilter(&$params) {
projects / civicrm-core.git / blobdiff