* Reference to an activity object.
*
* @return \CRM_Activity_BAO_ICalendar
- @access public
+ * @access public
*/
public function __construct(&$act) {
$this->activity = $act;
* @param array $contacts
* Array of contacts (attendees).
*
- * @return string
- * Array index of the added attachment in the $attachments array, or else NULL.
+ * @return string|null
+ * Array index of the added attachment in the $attachments array, else NULL.
*/
public function addAttachment(&$attachments, $contacts) {
// Check preferences setting
return NULL;
}
+ /**
+ * Remove temp file
+ */
public function cleanup() {
if (!empty ($this->icsfile)) {
@unlink($this->icsfile);
}
}
- // TODO: Is there a better way to do this?
/**
+ * TODO: Is there a better way to do this?
* @return string
*/
private function getPrimaryEmail() {
* @param null $activityTypeIDs
*
* @return \CRM_Activity_Selector_Activity
- @access public
+ * @access public
*/
function __construct(
$contactId,
* @param null $compContext
*
* @return \CRM_Activity_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
*
* @throws Exception
* @return void
- @access public
+ * @access public
* @static
*/
public static function sendEmail($params, $sendEmailMode) {
* @param string $context
*
* @return \CRM_Campaign_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
* @param string $context
*
* @return \CRM_Case_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
* @param string $operator
*
* @return \CRM_Contact_BAO_Query
- @access public
+ * @access public
*/
function __construct(
$params = NULL, $returnProperties = NULL, $fields = NULL,
* This is contact id for adding relationship.
*
* @return string
- @access public
+ * @access public
* @static
*/
public static function checkValidRelationship($params, $ids, $contactId) {
* @param null $contextMenu
*
* @return \CRM_Contact_Selector_Custom
- @access public
+ * @access public
*/
function __construct(
$customSearchClass,
* @param null $compContext
*
* @return \CRM_Contribute_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
* Class constructor
*
* @return \CRM_Core_DAO
- @access public
+ * @access public
*/
public function __construct() {
$this->initialize();
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
$this->_stateMachine = &$stateMachine;
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Cancel
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Display
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Done
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Jump
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Next
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Process
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Refresh
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Reload
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Reference to state machine object.
*
* @return \CRM_Core_QuickForm_Action_Submit
- @access public
+ * @access public
*/
public function __construct(&$stateMachine) {
parent::__construct($stateMachine);
* Element names of the various uploadable files.
*
* @return \CRM_Core_QuickForm_Action_Upload
- @access public
+ * @access public
*/
public function __construct(&$stateMachine, $uploadDir, $uploadNames) {
parent::__construct($stateMachine);
* @param null $case
*
* @return \CRM_Core_Selector_Controller
- @access public
+ * @access public
*/
public function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) {
* @param \const|int $action
*
* @return \CRM_Core_StateMachine
- @access public
+ * @access public
*/
public function __construct(&$controller, $action = CRM_Core_Action::NONE) {
$this->_controller = &$controller;
* @param null $compContext
*
* @return \CRM_Event_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base {
/**
- @var CRM_Extension_Mapper
+ * @var CRM_Extension_Mapper
*/
protected $mapper;
* @param string $context
*
* @return \CRM_Grant_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
*
*
* @return \CRM_Mailing_Selector_Browse
- @access public
+ * @access public
*/
public function __construct() {
}
* If the event type is a click-through, do we want only those from a specific url?.
*
* @return \CRM_Mailing_Selector_Event
- @access public
+ * @access public
*/
public function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) {
$this->_event_type = $event;
* @param null $compContext
*
* @return \CRM_Mailing_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
* Membership params as available to calling function - passed to the hook.
*
* @return array
- @static
+ * @static
*/
static function getMembershipStatusByDate(
$startDate, $endDate, $joinDate,
* Function that return the status ids whose is_current_member is set
*
* @return array
- @static
+ * @static
*/
public static function getMembershipStatusCurrent() {
$statusIds = array();
* @param string $context
*
* @return \CRM_Member_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
* @param string $context
*
* @return \CRM_Pledge_Selector_Search
- @access public
+ * @access public
*/
function __construct(
&$queryParams,
* @param bool $linkToUF
*
* @return \CRM_Profile_Selector_Listings
- @access public
+ * @access public
*/
function __construct(
&$params,
* The name of the form if different from class name.
*
* @return \CRM_Core_Form
- @access public
+ * @access public
*/
/**
* @param null|object $state
* Order to sort.
*
* @return \CRM_Utils_Sort
- @access public
+ * @access public
*/
public function __construct(&$vars, $defaultSortOrder = NULL) {
$this->_vars = array();
* @version $Id: CustomField.php 30879 2010-11-22 15:45:55Z shot $
*/
-/**
- * Most API functions take in associative arrays ( name => value pairs
- * as parameters. Some of the most commonly used parameters are
- * described below
- *
- * @param array $params
- * An associative array used in construction.
- * retrieval of the object
- *
- */
-
/**
* Create a 'custom field' within a custom field group.
* We also empty the static var in the getfields
* @param $params
* Array Associative array of property name/value pairs to create new custom field.
*
- * @return Newly API success object
+ * @return array
+ * API success array
*
* @access public
*
civicrm_api('custom_field', 'getfields', array('version' => 3, 'cache_clear' => 1));
CRM_Core_BAO_UFField::getAvailableFieldsFlat(TRUE);
}
+
/**
* Adjust Metadata for Create action
*
* @access public
**/
function civicrm_api3_custom_field_delete($params) {
-
$field = new CRM_Core_BAO_CustomField();
$field->id = $params['id'];
$field->find(TRUE);
*
* @param array $params
* Array to search on.
- * {*
*
* @return array
-@getfields CustomField_get}
+ * @getfields CustomField_get
* @access public
*
**/
* Collect validation errors.
*
* @return array
- * Validation errors
+ * Validation errors
* @todo remove this function - not in use but need to review functionality before
* removing as it might be useful in wrapper layer
*/
projects / civicrm-core.git / commitdiff