* [local_col_name] => "related_tablename:related_col_name"
*
*
- * @return array|null
+ * @return array|null
* array = if there are links defined for this table.
* empty array - if there is a links.ini file, but no links on this table
* null - if no links.ini exists for this database (hence try auto_links).
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param array $layoutInfo
* Associated array which contains meta data about format/layout.
*
- * @return void
+ * @return void
*/
public function createLabels(&$participants, &$layoutInfo) {
$this->pdf = new CRM_Utils_PDF_Label($layoutInfo['format'], 'mm');
* @param object $tag
* An object of a tag.
*
- * @return array $contactIds array of contact ids
+ * @return array $contactIds array of contact ids
*/
public function getEntitiesByTag($tag) {
$contactIds = array();
* @param int $activityId
* Activity id.
*
- * @return case subject or null
+ * @return string|null
* @static
*/
public static function getCaseSubject($activityId) {
* Get the case type.
*
* @param int $caseId
- *
* @param string $colName
*
- * @return case type
+ * @return string case type
* @static
*/
public static function getCaseType($caseId, $colName = 'title') {
*
* @param bool $all
*
- * @return array of basic contact types information.
+ * @return array of basic contact types information.
* @static
*/
public static function &basicTypeInfo($all = FALSE) {
*
* @param bool $all
*
- * @return array of basic contact types
+ * @return array of basic contact types
* @static
*/
public static function basicTypes($all = FALSE) {
* @param bool $ignoreCache
* @param bool $reset
*
- * @return array of sub type information
+ * @return array of sub type information
* @static
*/
public static function &subTypeInfo($contactType = NULL, $all = FALSE, $ignoreCache = FALSE, $reset = FALSE) {
* @param string $columnName
* @param bool $ignoreCache
*
- * @return array of all subtypes OR list of subtypes associated to
+ * @return array of all subtypes OR list of subtypes associated to
* a given basic contact type
* @static
*/
*
* @param bool $all
*
- * @return array of basic types + all subtypes.
+ * @return array of basic types + all subtypes.
* @static
*/
public static function contactTypes($all = FALSE) {
* @param bool $all
* @param bool $reset
*
- * @return array of basic types + all subtypes.
+ * @return array of basic types + all subtypes.
* @static
*/
public static function contactTypeInfo($all = FALSE, $reset = FALSE) {
* Contact subType.
* @param bool $ignoreCache
*
- * @return boolean true if subType, false otherwise.
+ * @return boolean true if subType, false otherwise.
* @static
*/
public static function isaSubType($subType, $ignoreCache = FALSE) {
$this->_alreadyStyled = FALSE;
}
+ /**
+ * @return mixed
+ */
public function current() {
if ($this->_styleLabels &&
$this->valid() &&
* @param $childID
* The id of the child group being removed.
*
- * @return void
+ * @return void
*
*/
public static function remove($parentID, $childID) {
* @param int $childID
* The id of the child group being removed.
*
- * @return void
+ * @return void
*
*/
public static function removeAllParentForChild($childID) {
* @param $childID
* The child id of the association.
*
- * @return boolean True if association is found, false otherwise.
+ * @return boolean
+ * True if association is found, false otherwise.
*
*/
public static function isParentChild($parentID, $childID) {
* @param $groupId
* The id of the group to check for child groups.
*
- * @return boolean True if 1 or more child groups are found, false otherwise.
+ * @return boolean
+ * True if 1 or more child groups are found, false otherwise.
*
*/
public static function hasChildGroups($groupId) {
* @param $groupId
* The id of the group to check for parent groups.
*
- * @return boolean True if 1 or more parent groups are found, false otherwise.
- *
+ * @return boolean
+ * True if 1 or more parent groups are found, false otherwise.
*/
public static function hasParentGroups($groupId) {
$dao = new CRM_Contact_DAO_GroupNesting();
* @param $checkGroupId
* The group id to check if it is a parent of the $groupIds group(s).
*
- * @return boolean True if $checkGroupId points to a group that is a parent of one of the $groupIds groups, false otherwise.
+ * @return boolean
+ * True if $checkGroupId points to a group that is a parent of one of the $groupIds groups, false otherwise.
*
*/
public static function isParentGroup($groupIds, $checkGroupId) {
* @param $checkGroupId
* The group id to check if it is a child of the $groupIds group(s).
*
- * @return boolean True if $checkGroupId points to a group that is a child of one of the $groupIds groups, false otherwise.
+ * @return boolean
+ * True if $checkGroupId points to a group that is a child of one of the $groupIds groups, false otherwise.
*
*/
public static function isChildGroup($groupIds, $checkGroupId) {
* @param $checkGroupId
* The group id to check if it is an ancestor of the $groupIds group(s).
*
- * @return boolean True if $checkGroupId points to a group that is an ancestor of one of the $groupIds groups, false otherwise.
+ * @return boolean
+ * True if $checkGroupId points to a group that is an ancestor of one of the $groupIds groups, false otherwise.
*
*/
public static function isAncestorGroup($groupIds, $checkGroupId) {
* @param $checkGroupId
* The group id to check if it is a descendent of the $groupIds group(s).
*
- * @return boolean True if $checkGroupId points to a group that is a descendent of one of the $groupIds groups, false otherwise.
+ * @return boolean
+ * True if $checkGroupId points to a group that is a descendent of one of the $groupIds groups, false otherwise.
*
*/
public static function isDescendentGroup($groupIds, $checkGroupId) {
*
* @param bool $includeSelf
*
- * @return array $groupIdArray List of groupIds that represent the requested group and its ancestors@access public
+ * @return array
+ * List of groupIds that represent the requested group and its ancestors@access public
*/
public static function getAncestorGroupIds($groupIds, $includeSelf = TRUE) {
if (!is_array($groupIds)) {
* An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
- * @return \An $groupArray List of ancestor groups@access public
+ * @return array
+ * List of ancestor groups@access public
*/
public static function getAncestorGroups($groupIds, $includeSelf = TRUE) {
$groupIds = self::getAncestorGroupIds($groupIds, $includeSelf);
* @param array $groupIds
* An array of valid group ids (passed by reference).
*
- * @return array $groupIdArray List of groupIds that represent the requested group and its children@access public
+ * @return array
+ * List of groupIds that represent the requested group and its children@access public
*/
public static function getChildGroupIds($groupIds) {
if (!is_array($groupIds)) {
* @param array $groupIds
* An array of valid group ids (passed by reference).
*
- * @return array $groupIdArray List of groupIds that represent the requested group and its parents@access public
+ * @return array
+ * List of groupIds that represent the requested group and its parents@access public
*/
public static function getParentGroupIds($groupIds) {
if (!is_array($groupIds)) {
* An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
- * @return array $groupIdArray List of groupIds that represent the requested group and its descendents@access public
+ * @return array
+ * List of groupIds that represent the requested group and its descendents@access public
*/
public static function getDescendentGroupIds($groupIds, $includeSelf = TRUE) {
if (!is_array($groupIds)) {
* Returns array of descendent groups of the specified group.
*
* @param array $groupIds
- * An array of valid group ids (passed by reference).
+ * An array of valid group ids
*
* @param bool $includeSelf
- * @return \An $groupArray List of descendent groups@access public
+ * @return array
+ * List of descendent groups@access public
*/
public static function getDescendentGroups($groupIds, $includeSelf = TRUE) {
$groupIds = self::getDescendentGroupIds($groupIds, $includeSelf);
* @param $groupId
* The group id to get valid potential children for.
*
- * @return array $groupIdArray List of groupIds that represent the valid potential children of the group@access public
+ * @return array
+ * List of groupIds that represent the valid potential children of the group@access public
*/
public static function getPotentialChildGroupIds($groupId) {
$groups = CRM_Contact_BAO_Group::getGroups();
* @param string $fileName
* The name of the file to save the label in.
*
- * @return null
+ * @return null
*/
public function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') {
$pdf = new CRM_Utils_PDF_Label($format, 'mm');
* @param string $fileName
* The name of the file to save the label in.
*
- * @return null
+ * @return null
*/
public static function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') {
$pdf = new CRM_Utils_PDF_Label($format, 'mm');
/**
* Get address sequence
*
- * @return array of address sequence.
+ * @return array of address sequence.
*/
public static function addressSequence() {
$config = CRM_Core_Config::singleton();
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object DAO object on sucess, null otherwise
*
* @static
*/
* @param object $field
* The field object.
*
- * @return boolean
+ * @return boolean
*
* @static
*
* @param int $contactID
* @param int $fieldID
*
- * @return string the display value
+ * @return string the display value
*
* @static
*/
*
* @param NULL
*
- * @return array array of strings
+ * @return array array of strings
*/
public function query() {
$this->select();
* @param object $tag
* An object of a tag.
*
- * @return array $entityIds array of entity ids
+ * @return array $entityIds array of entity ids
*/
public function getEntitiesByTag($tag) {
$entityIds = array();
*
* @param int $ufGroupId
*
- * @return true for mix profile else false
+ * @return true for mix profile else false
* @static
*/
public static function checkProfileType($ufGroupId) {
*
* @param $ctype
*
- * @return true for mix profile group else false
+ * @return true for mix profile group else false
* @static
*/
public static function checkProfileGroupType($ctype) {
/**
* Performs the server side validation
* @since 1.0
- * @return boolean true if no error found
+ * @return boolean true if no error found
* @throws HTML_QuickForm_Error
*/
public function validate() {
* @param bool $justEnabled
* whether to return all languages or just the enabled ones.
*
- * @return array of code/language name mappings
+ * @return array of code/language name mappings
*/
public static function languages($justEnabled = FALSE) {
static $all = NULL;
* source string.
* @param mixed arguments, can be passed in an array or through single variables
*
- * @return string modified string
+ * @return string modified string
*/
public function strarg($str) {
$tr = array();
* @param array $params
* the params of the translation (if any).
*
- * @return string the translated string
+ * @return string the translated string
*/
public function crm_translate($text, $params = array()) {
if (isset($params['escape'])) {
* @param string $string
* this string should be translated.
*
- * @return string the translated string
+ * @return string the translated string
*/
public function translate($string) {
return ($this->_phpgettext) ? $this->_phpgettext->translate($string) : $string;
* @param array $params
* an array of additional parameters.
*
- * @return void
+ * @return void
*/
function localizeArray(
&$array,
* @param array $array
* the array for localization (in place).
*
- * @return void
+ * @return void
*/
public function localizeTitles(&$array) {
foreach ($array as $key => $value) {
* @param $params
* Array an array of additional parameters.
*
- * @return string the translated string
+ * @return string the translated string
*/
function ts($text, $params = array()) {
static $config = NULL;
/**
* Returns the HTML generated for the advanced mutliple select component
*
- * @return string
+ * @return string
* @since version 0.4.0 (2005-06-25)
*/
public function toHtml() {
* (optional) See function detail.
*
* @since version 1.5.0 (2009-02-15)
- * @return PEAR_Error|NULL on error and TRUE on success
+ * @return PEAR_Error|NULL on error and TRUE on success
* @throws PEAR_Error
* @see loadArray()
*/
*
* @param bool $outputHeader
*
- * @return mixed empty if output is printed, else output
+ * @return mixed empty if output is printed, else output
*
* @static
*/
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array array of action links that we need to display for the browse screen
*/
public function &actionLinks() {
// check if variable _actionsLinks is populated
* @param bool $onlyPublicInclude public events only, default TRUE.
* Include public events only, default TRUE.
*
- * @return array $all array of all the events that are searched
+ * @return array $all array of all the events that are searched
* @static
*/
static function &getCompleteInfo(
*
* @param array $participants
*
- * @return null
+ * @return null
*/
public function run(&$participants) {
// fetch the 1st participant, and take her event to retrieve its attributes
*
* @param array $participants
*
- * @return null
+ * @return null
*/
public function createLabels(&$participants) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object DAO object on sucess, null otherwise
*
* @static
*/
* @param int $id
* Field Id.
*
- * @return boolean
+ * @return boolean
*
* @static
*
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object DAO object on sucess, null otherwise
*
* @static
*/
* @param int $id
* Id.
*
- * @return boolean
+ * @return boolean
*
* @static
*/
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array array of action links that we need to display for the browse screen
*/
function &actionLinks() {
// check if variable _actionsLinks is populated
* This is a first version and will be tweaked over a period of time
*
*
- * @return boolean true if no error found
+ * @return boolean true if no error found
*/
public function validate() {
$errors = parent::validate();
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object DAO object on sucess, null otherwise
*
* @static
*/
* @param int $id
* Field Id.
*
- * @return boolean
+ * @return boolean
*
* @static
*
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object DAO object on sucess, null otherwise
*
* @static
*/
* @param int $id
* Id.
*
- * @return boolean
+ * @return boolean
*
* @static
*/
* @param $text
* Text to escape.
*
- * @return Escaped text
+ * @return Escaped text
*
*/
public static function formatText($text) {
*
* @param bool $gdata
*
- * @return Escaped date
+ * @return Escaped date
*/
public static function formatDate($date, $gdata = FALSE) {
*
* @param array Uploaded file info (from $_FILES)
*
- * @return bool true if file has been uploaded, false otherwise
+ * @return bool true if file has been uploaded, false otherwise
*/
public static function asciiFile($elementValue) {
if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
*
* @param array Uploaded file info (from $_FILES)
*
- * @return bool whether file has been uploaded properly and is now in UTF-8
+ * @return bool whether file has been uploaded properly and is now in UTF-8
*/
public static function utf8File($elementValue) {
$success = FALSE;
*
* @param array Uploaded file info (from $_FILES)
*
- * @return bool true if file has been uploaded, false otherwise
+ * @return bool true if file has been uploaded, false otherwise
*/
public static function htmlFile($elementValue) {
if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found tags else error
+ * @return array details of found tags else error
*
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found addresses else error
+ * @return array details of found addresses else error
* {@getfields address_get}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result
+ * @return array api result
* {@getfields contribution_soft_get}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result array
+ * @return array api result array
* {@getfields country_get}
* @access public
*/
* Array Associative array of property name/value pairs to insert in group.
* {@getfields CustomGroup_create}
*
- * @return Newly create custom_group object
+ * @return Newly create custom_group object
* @todo $params['extends'] is array format - is that std compatible
* @access public
*/
* {@example OptionValueGet.php 0}
* @example OptionValueGet.php
*
- * @return array details of found Option Values
+ * @return array details of found Option Values
* {@getfields OptionValue_get}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result array
+ * @return array api result array
* {@getfields email_get}
* @access public
*/
* An associative array of name/value property values of civicrm_event.
* {@getfields event_get}
*
- * @return Array of all found event property values.
+ * @return Array of all found event property values.
* @access public
*
*/
* @param array $params
* An associative array of name/value property values of civicrm_file.
*
- * @return Array of all found file object property values.
+ * @return Array of all found file object property values.
* @access public
*/
function civicrm_api3_file_get($params) {
* Name value pair of contact information.
* {@getfields GroupContact_get}
*
- * @return array list of groups, given contact subsribed to
+ * @return array list of groups, given contact subsribed to
*/
function civicrm_api3_group_contact_get($params) {
* An array containing at least child_group_id or parent_group_id.
* {@getfields GroupNesting_get}
*
- * @return array list of group nesting records
+ * @return array list of group nesting records
*/
function civicrm_api3_group_nesting_get($params) {
* {@getfields GroupOrganization_get}
* @example GroupOrganizationGet.php
*
- * @return array list of groups, given contact subsribed to
+ * @return array list of groups, given contact subsribed to
*/
function civicrm_api3_group_organization_get($params) {
return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found IM
+ * @return array details of found IM
*
* @access public
*/
/**
* Retrieve one or more job
* @param array input parameters
- * @return array api result array
+ * @return array api result array
* {@getfields email_get}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result
+ * @return array api result
* {@getfields LocationType_get}
* @access public
*/
* options affecting the desired results; has legacy support
* for just passing the contact_id itself as the argument
*
- * @return Array of all found membership property values.
+ * @return Array of all found membership property values.
* @access public
* @todo needs some love - basically only a get for a given contact right now
* {@getfields membership_get}
* @param array $params
* An associative array of name/value property values of civicrm_membership_status.
*
- * @return Array of all found membership status property values.
+ * @return Array of all found membership status property values.
* {@getfields MembershipStatus_get}
* @access public
*/
* An associative array of name/value property values of civicrm_membership_type.
* {getfields MembershipType_get}
*
- * @return Array of all found membership type property values.
+ * @return Array of all found membership type property values.
* @access public
*/
function civicrm_api3_membership_type_get($params) {
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result array
+ * @return array api result array
* {@getfields message_template_get}
* @access public
*/
* {@example OptionValueGet.php 0}
* @example OptionValueGet.php
*
- * @return array details of found Option Values
+ * @return array details of found Option Values
* {@getfields OptionValue_get}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found PaymentProcessor
+ * @return array details of found PaymentProcessor
* @access public
*/
function civicrm_api3_payment_processor_get($params) {
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found phones else error
+ * @return array details of found phones else error
* @access public
* This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstrate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php .
*/
* - if you pass in contact_id - it just returns all relationships for 'contact_id'
* - if you don't pass in contact_id then it does a filter on the relationship table (DAO based search)
*
- * @return Array API Result Array
+ * @return Array API Result Array
* {@getfields relationship_get}
* @example RelationshipGet.php
* @access public
* @param array $params
* Input parameters.
*
- * @return array details of found instances
+ * @return array details of found instances
* @access public
*/
function civicrm_api3_report_instance_get($params) {
* {@example OptionValueGet.php 0}
* @example OptionValueGet.php
*
- * @return array details of found Option Values
+ * @return array details of found Option Values
* {@getfields OptionValue_get}
* @access public
*/
* @param array $params
* Input parameters.
*
- * @return array details of found instances
+ * @return array details of found instances
* @access public
*/
function civicrm_api3_report_template_getrows($params) {
* @param array $params
* Input parameters.
*
- * @return array details of found instances
+ * @return array details of found instances
* @access public
*/
function _civicrm_api3_report_template_getrows_spec(&$params) {
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found tags else error
+ * @return array details of found tags else error
* {@getfields tag_get}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found websites
+ * @return array details of found websites
*
* @access public
*/
* @strings array array of strings or a single string
*
* @param $strings
- * @return void
+ * @return void
*/
public function assertStringsPresent($strings) {
foreach ((array) $strings as $string) {
* @url string url to parse or retrieve current url if null
*
* @param null $url
- * @return array returns an associative array containing any of the various components
+ * @return array returns an associative array containing any of the various components
* of the URL that are present. Querystring elements are returned in sub-array (elements.queryString)
* http://php.net/manual/en/function.parse-url.php
*/
projects / civicrm-core.git / commitdiff