/**
* Create a follow up a given activity
*
- * @param $activityId
- * Int activity id of parent activity.
+ * @param int $activityId
+ * activity id of parent activity.
* @param array $params
*
* @return $this|null|object
/**
* Get Surveys custom groups
*
- * @param $surveyTypes
- * Array an array of survey type id.
+ * @param array $surveyTypes
+ * an array of survey type id.
*
* @return array
* @static
* Build form for related contacts / on behalf of organization.
*
* @param CRM_Core_Form $form
- * @param $contactType
- * String contact type.
+ * @param string $contactType
+ * contact type.
* @param int $countryID
* @param int $stateID
- * @param $title
- * String fieldset title.
+ * @param string $title
+ * fieldset title.
*
* @static
*/
/**
* Change the cache_date
*
- * @param $groupID
- * Array(int).
- * @param $processed
- * Bool, whether the cache data was recently modified.
+ * @param array $groupID
+ * @param bool $processed
+ * Whether the cache data was recently modified.
*/
public static function updateCacheTime($groupID, $processed) {
// only update cache entry if we had any values
* cache date, i.e. the removal is not done if the group was recently
* loaded into the cache.
*
- * @param $groupID
- * Int the groupID to delete cache entries, NULL for all groups.
- * @param $onceOnly
- * Boolean run the function exactly once for all groups.
+ * @param int $groupID
+ * the groupID to delete cache entries, NULL for all groups.
+ * @param bool $onceOnly
+ * run the function exactly once for all groups.
*
* @return void
* @static
* Returns true if checkGroupId is a parent of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds
- * Array of group ids (or one group id) to serve as the starting point.
+ * @param array $groupIds
+ * of group ids (or one group id) to serve as the starting point.
* @param $checkGroupId
* The group id to check if it is a parent of the $groupIds group(s).
*
* Returns true if checkGroupId is a child of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds
- * Array of group ids (or one group id) to serve as the starting point.
+ * @param array $groupIds
+ * of group ids (or one group id) to serve as the starting point.
* @param $checkGroupId
* The group id to check if it is a child of the $groupIds group(s).
*
* Returns true if checkGroupId is an ancestor of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds
- * Array of group ids (or one group id) to serve as the starting point.
+ * @param array $groupIds
+ * of group ids (or one group id) to serve as the starting point.
* @param $checkGroupId
* The group id to check if it is an ancestor of the $groupIds group(s).
*
* Returns true if checkGroupId is a descendent of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds
- * Array of group ids (or one group id) to serve as the starting point.
+ * @param array $groupIds
+ * of group ids (or one group id) to serve as the starting point.
* @param $checkGroupId
* The group id to check if it is a descendent of the $groupIds group(s).
*
/**
* Returns array of group ids of ancestor groups of the specified group.
*
- * @param $groupIds
+ * @param array $groupIds
* An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
/**
* Returns array of ancestor groups of the specified group.
*
- * @param $groupIds
+ * @param array $groupIds
* An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
/**
* Returns array of group ids of child groups of the specified group.
*
- * @param $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 children@access public
/**
* Returns array of group ids of parent groups of the specified group.
*
- * @param $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
/**
* Returns array of group ids of descendent groups of the specified group.
*
- * @param $groupIds
+ * @param array $groupIds
* An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
/**
* Returns array of descendent groups of the specified group.
*
- * @param $groupIds
+ * @param array $groupIds
* An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
/**
* Builds the necessary structures for all fields that are similar to option value lookups
*
- * @param $name
- * String the name of the field.
- * @param $op
- * String the sql operator, this function should handle ALL SQL operators.
- * @param $value
- * String|integer|array depends on the operator and who's calling the query builder.
- * @param $grouping
- * Int the index where to place the where clause.
+ * @param string $name
+ * the name of the field.
+ * @param string $op
+ * the sql operator, this function should handle ALL SQL operators.
+ * @param string $value
+ * depends on the operator and who's calling the query builder.
+ * @param int $grouping
+ * the index where to place the where clause.
* @param $selectValues
* The key value pairs for this element. This allows us to use this function for things besides option-value pairs.
- * @param $field
- * Array an array that contains various properties of the field identified by $name.
- * @param $label
- * String The label for this field element.
- * @param $dataType
- * String The data type for this element.
+ * @param array $field
+ * an array that contains various properties of the field identified by $name.
+ * @param string $label
+ * The label for this field element.
+ * @param string $dataType
+ * The data type for this element.
* @param bool $useIDsOnly
*
* @return void adds the where clause and qill to the query object
* membership is is extedned by the same relationship type to that
* of the existing relationship.
*
- * @param $contactId
- * Int contact id.
- * @param $params
- * Array array of values submitted by POST.
- * @param $ids
- * Array array of ids.
+ * @param int $contactId
+ * contact id.
+ * @param array $params
+ * array of values submitted by POST.
+ * @param array $ids
+ * array of ids.
* @param \const|\which $action which action called this function
*
* @param bool $active
/**
* Return list of permissioned employer for a given contact.
*
- * @param $contactID
- * Int contact id whose employers.
+ * @param int $contactID
+ * contact id whose employers.
* are to be found.
- * @param $name
- * String employers sort name.
+ * @param string $name
+ * employers sort name.
*
* @static
*
/**
* Function to return list of permissioned contacts for a given contact and relationship type
*
- * @param $contactID
- * Int contact id whose permissioned contacts are to be found.
- * @param $relTypeId
- * String one or more relationship type id's.
- * @param $name
- * String.
+ * @param int $contactID
+ * contact id whose permissioned contacts are to be found.
+ * @param string $relTypeId
+ * one or more relationship type id's.
+ * @param string $name
*
* @static
*
* This function either parse street address in to child
* elements or build street address from child elements.
*
- * @param $params
- * Array of key value consist of address blocks.
+ * @param array $params
+ * of key value consist of address blocks.
*
* @return array $parseSuccess as array of sucess/fails for each address block@static
*/
* Check parse result and if some address block fails then this
* function return the status message for all address blocks.
*
- * @param $parseResult
+ * @param array $parseResult
* An array of address blk instance and its status.
*
* @return null|string $statusMsg string status message for all address blocks.@static
* Convert normal number to ordinal number format.
* like 1 => 1st, 2 => 2nd and so on...
*
- * @param $number
- * Int number to convert in to ordinal number.
+ * @param int $number
+ * number to convert in to ordinal number.
*
* @return ordinal number for given number.
* @static
* Update membership status to deceased
* function return the status message for updated membership.
*
- * @param $deceasedParams
- * Array having contact id and deceased value.
+ * @param array $deceasedParams
+ * having contact id and deceased value.
*
* @return null|string $updateMembershipMsg string status message for updated membership.
*/
/**
* Normalize default values for multiselect plugins
*
- * @param $defaults
- * Array.
+ * @param array $defaults
* @return array
*/
public function normalizeDefaultValues(&$defaults) {
/**
* Format params for update and fill mode
*
- * @param $params
- * Array reference to an array containing all the.
+ * @param array $params
+ * reference to an array containing all the.
* values for import
- * @param $onDuplicate
- * Int.
- * @param $cid
- * Int contact id.
+ * @param int $onDuplicate
+ * @param int $cid
+ * contact id.
*/
public function formatParams(&$params, $onDuplicate, $cid) {
if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) {
*
* @param $values
* @param $input
- * @param $template
- * CRM_Core_SMARTY.
+ * @param CRM_Core_SMARTY $template
* @param bool $recur
* @param bool $returnMessageText
*
/**
* @param $submittedValues
* @param $config
- * @param $session
- * CRM_Core_Session.
+ * @param CRM_Core_Session $session
* @param $lineItem
*
* @throws CRM_Core_Exception
/**
* Add on behalf of organization and it's location
*
- * @param $behalfOrganization
- * Array array of organization info.
- * @param $contactID
- * Int individual contact id. One.
+ * @param array $behalfOrganization
+ * array of organization info.
+ * @param int $contactID
+ * individual contact id. One.
* who is doing the process of signup / contribution.
*
- * @param $values
- * Array form values array.
+ * @param array $values
+ * form values array.
* @param array $params
* @param null $fields
*
* If there are custom-groups which only apply to certain subtypes,
* those WILL be included.
*
- * @param $entityType
- * String.
+ * @param string $entityType
*
* @return CRM_Core_DAO_CustomGroup
*/
*
* @param $group
* Object the DAO custom group object.
- * @param $force
- * Boolean whether to force the deletion, even if there are custom fields.
+ * @param bool $force
+ * whether to force the deletion, even if there are custom fields.
*
* @return boolean false if field exists for this group, true if group gets deleted.
*
* Returns the option label for a custom field with a specific value. Handles all
* custom field data and html types
*
- * @param $fieldId
- * Int the custom field ID.
+ * @param int $fieldId
+ * the custom field ID.
* @pram $value string the value (typically from the DB) of this custom field
* @param $value
- * @param $htmlType
- * String the html type of the field (optional).
- * @param $dataType
- * String the data type of the field (optional).
+ * @param string $htmlType
+ * the html type of the field (optional).
+ * @param string $dataType
+ * the data type of the field (optional).
*
* @return string the label to display for this custom field
* @static
/**
* Change the schema version of an extension
*
- * @param $fullName
- * String, the fully-qualified name (eg "com.example.myextension").
- * @param $schemaVersion
- * String.
+ * @param string $fullName
+ * the fully-qualified name (eg "com.example.myextension").
+ * @param string $schemaVersion
* @return void
*/
public static function setSchemaVersion($fullName, $schemaVersion) {
/**
* Determine the schema version of an extension
*
- * @param $fullName
- * String, the fully-qualified name (eg "com.example.myextension").
+ * @param string $fullName
+ * the fully-qualified name (eg "com.example.myextension").
* @return string
*/
public static function getSchemaVersion($fullName) {
* Return a clean url string and the number of attachment for a
* given entityTable, entityID
*
- * @param $entityTable
- * String The entityTable to which the file is attached.
- * @param $entityID
- * Int The id of the object in the above entityTable.
- * @param $separator
- * String The string separator where to implode the urls.
+ * @param string $entityTable
+ * The entityTable to which the file is attached.
+ * @param int $entityID
+ * The id of the object in the above entityTable.
+ * @param string $separator
+ * The string separator where to implode the urls.
*
* @return array An array with 2 elements. The string and the number of attachments
* @static
/**
* Display paper icon for a file attachment -- CRM-13624
*
- * @param $entityTable
- * String The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity".
+ * @param string $entityTable
+ * The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity".
* If you have the ID of a specific row in civicrm_file, use $entityTable='*'
- * @param $entityID
- * Int The id of the object in the above entityTable.
+ * @param int $entityID
+ * The id of the object in the above entityTable.
*
* @return array|NULL list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL
*
/**
* Check Duplicate Mapping Name
*
- * @param $nameField
- * String mapping Name.
- * @param $mapTypeId
- * String mapping Type.
+ * @param string $nameField
+ * mapping Name.
+ * @param string $mapTypeId
+ * mapping Type.
*
* @return boolean
*/
/**
* Calculate navigation weight
*
- * @param $parentID
+ * @param int $parentID
* Parent_id of a menu.
- * @param $menuID
+ * @param int $menuID
* Menu id.
*
* @return int $weight string@static
/**
* Update the email value for the contact and user profile
*
- * @param $contactId
- * Int Contact ID of the user.
+ * @param int $contactId
+ * Contact ID of the user.
* @param $emailAddress
* Email to be modified for the user.
*
/**
* Singleton function used to manage this object.
*
- * @param $loadFromDB
- * Boolean whether to load from the database.
- * @param $force
- * Boolean whether to force a reconstruction.
+ * @param bool $loadFromDB
+ * whether to load from the database.
+ * @param bool $force
+ * whether to force a reconstruction.
*
* @return CRM_Core_Config
* @static
/**
* Escape a list of strings for use with "WHERE X IN (...)" queries.
*
- * @param $strings
- * Array.
- * @param $default
- * String the value to use if $strings has no elements.
+ * @param array $strings
+ * @param string $default
+ * the value to use if $strings has no elements.
* @return string eg "abc","def","ghi"
*/
public static function escapeStrings($strings, $default = NULL) {
* Build a list of triggers via hook and add them to (err, reconcile them
* with) the database.
*
- * @param $tableName
- * String the specific table requiring a rebuild; or NULL to rebuild all tables.
+ * @param string $tableName
+ * the specific table requiring a rebuild; or NULL to rebuild all tables.
* @param bool $force
*
* @see CRM-9716
/**
* Wrapper function to drop triggers
*
- * @param $tableName
- * String the specific table requiring a rebuild; or NULL to rebuild all tables.
+ * @param string $tableName
+ * the specific table requiring a rebuild; or NULL to rebuild all tables.
*/
public static function dropTriggers($tableName = NULL) {
$info = array();
}
/**
- * @param $info
- * Array per hook_civicrm_triggerInfo.
- * @param $onlyTableName
- * String the specific table requiring a rebuild; or NULL to rebuild all tables.
+ * @param array $info
+ * per hook_civicrm_triggerInfo.
+ * @param string $onlyTableName
+ * the specific table requiring a rebuild; or NULL to rebuild all tables.
*/
public static function createTriggers(&$info, $onlyTableName = NULL) {
// Validate info array, should probably raise errors?
*
* @param string $fieldName
* Name of fields.
- * @param $filter
- * Array filter to be applied indexed by operator.
- * @param $type
- * String type of field (not actually used - nor in api @todo ).
- * @param $alias
- * String alternative field name ('as') @todo- not actually used.
+ * @param array $filter
+ * filter to be applied indexed by operator.
+ * @param string $type
+ * type of field (not actually used - nor in api @todo ).
+ * @param string $alias
+ * alternative field name ('as') @todo- not actually used.
* @param bool $returnSanitisedArray
* Return a sanitised array instead of a clause.
* this is primarily so we can add filters @ the api level to the Query object based fields
/**
* A locale-based constructor that shouldn't be called from outside of this class (use singleton() instead).
*
- * @param $locale
- * String the base of this certain object's existence.
+ * @param string $locale
+ * the base of this certain object's existence.
*
* @return \CRM_Core_I18n
*/
/**
* Return languages available in this instance of CiviCRM.
*
- * @param $justEnabled
- * Boolean whether to return all languages or just the enabled ones.
+ * @param bool $justEnabled
+ * whether to return all languages or just the enabled ones.
*
* @return array of code/language name mappings
*/
/**
* Replace arguments in a string with their values. Arguments are represented by % followed by their number.
*
- * @param $str
- * String source string.
+ * @param string $str
+ * source string.
* @param mixed arguments, can be passed in an array or through single variables
*
* @return string modified string
* - count - The item count for plural mode (3rd parameter of ngettext())
* - context - gettext context of that string (for homonym handling)
*
- * @param $text
- * String the original string.
- * @param $params
- * Array the params of the translation (if any).
+ * @param string $text
+ * the original string.
+ * @param array $params
+ * the params of the translation (if any).
*
* @return string the translated string
*/
/**
* Translate a string to the current locale.
*
- * @param $string
- * String this string should be translated.
+ * @param string $string
+ * this string should be translated.
*
* @return string the translated string
*/
/**
* Localize (destructively) array values.
*
- * @param $array
- * Array the array for localization (in place).
- * @param $params
- * Array an array of additional parameters.
+ * @param array $array
+ * the array for localization (in place).
+ * @param array $params
+ * an array of additional parameters.
*
* @return void
*/
/**
* Localize (destructively) array elements with keys of 'title'.
*
- * @param $array
- * Array the array for localization (in place).
+ * @param array $array
+ * the array for localization (in place).
*
* @return void
*/
* Switch database from single-lang to multi (by adding
* the first language and dropping the original columns).
*
- * @param $locale
- * String the first locale to create (migrate to).
+ * @param string $locale
+ * the first locale to create (migrate to).
*
* @return void
*/
* Switch database from multi-lang back to single (by dropping
* additional columns and views and retaining only the selected locale).
*
- * @param $retain
- * String the locale to retain.
+ * @param string $retain
+ * the locale to retain.
*
* @return void
*/
/**
* Switch a given table from multi-lang to single (by retaining only the selected locale).
*
- * @param $retain
- * String the locale to retain.
- * @param $table
- * String the table containing the column.
- * @param $class
- * String schema structure class to use to recreate indices.
+ * @param string $retain
+ * the locale to retain.
+ * @param string $table
+ * the table containing the column.
+ * @param string $class
+ * schema structure class to use to recreate indices.
*
* @param array $triggers
*
* Add a new locale to a multi-lang db, setting
* its values to the current default locale.
*
- * @param $locale
- * String the new locale to add.
- * @param $source
- * String the locale to copy from.
+ * @param string $locale
+ * the new locale to add.
+ * @param string $source
+ * the locale to copy from.
*
* @return void
*/
/**
* Rebuild multilingual indices, views and triggers (useful for upgrades)
*
- * @param $locales
- * Array locales to be rebuilt.
- * @param $version
- * String version of schema structure to use.
+ * @param array $locales
+ * locales to be rebuilt.
+ * @param string $version
+ * version of schema structure to use.
*
* @return void
*/
/**
* Rewrite SQL query to use views to access tables with localized columns.
*
- * @param $query
- * String the query for rewrite.
+ * @param string $query
+ * the query for rewrite.
*
* @return string the rewritten query
*/
/**
* CREATE INDEX queries for a given locale and table
*
- * @param $locale
- * String locale for which the queries should be created (null to create original indices).
- * @param $table
- * String table for which the queries should be created.
- * @param $class
- * String schema structure class to use.
+ * @param string $locale
+ * locale for which the queries should be created (null to create original indices).
+ * @param string $table
+ * table for which the queries should be created.
+ * @param string $class
+ * schema structure class to use.
*
* @return array array of CREATE INDEX queries
*/
/**
* CREATE VIEW query for a given locale and table
*
- * @param $locale
- * String locale of the view.
- * @param $table
- * String table of the view.
+ * @param string $locale
+ * locale of the view.
+ * @param string $table
+ * table of the view.
* @param CRM_Core_DAO $dao
* A DAO object to run DESCRIBE queries.
- * @param $class
- * String schema structure class to use.
+ * @param string $class
+ * schema structure class to use.
*
* @return array array of CREATE INDEX queries
*/
* Create, update, and delete entities declared by an active module
*
* @param \CRM_Core_Module|string $module string
- * @param $todos
- * Array $name => array().
+ * @param array $todos
+ * $name => array().
*/
public function reconcileEnabledModule(CRM_Core_Module $module, $todos) {
$dao = new CRM_Core_DAO_Managed();
* (radio, select, checkbox etc). OptionGroups for most cases have the
* 'label' in the label colum and the 'id' or 'name' in the value column
*
- * @param $name
- * String name of the option group.
- * @param $flip
- * Boolean results are return in id => label format if false.
+ * @param string $name
+ * name of the option group.
+ * @param bool $flip
+ * results are return in id => label format if false.
* if true, the results are reversed
- * @param $grouping
- * Boolean if true, return the value in 'grouping' column.
- * @param $localize
- * Boolean if true, localize the results before returning.
- * @param $condition
- * String add another condition to the sql query.
- * @param $labelColumnName
- * String the column to use for 'label'.
- * @param $onlyActive
- * Boolean return only the action option values.
- * @param $fresh
- * Boolean ignore cache entries and go back to DB.
- * @param $keyColumnName
- * String the column to use for 'key'.
+ * @param bool $grouping
+ * if true, return the value in 'grouping' column.
+ * @param bool $localize
+ * if true, localize the results before returning.
+ * @param string $condition
+ * add another condition to the sql query.
+ * @param string $labelColumnName
+ * the column to use for 'label'.
+ * @param bool $onlyActive
+ * return only the action option values.
+ * @param bool $fresh
+ * ignore cache entries and go back to DB.
+ * @param string $keyColumnName
+ * the column to use for 'key'.
*
* @return array the values as specified by the above params
* @static
* (radio, select, checkbox etc). OptionGroups for most cases have the
* 'label' in the label colum and the 'id' or 'name' in the value column
*
- * @param $id
- * Integer id of the option group.
- * @param $flip
- * Boolean results are return in id => label format if false.
- * if true, the results are reversed
- * @param $grouping
- * Boolean if true, return the value in 'grouping' column.
- * @param $localize
- * Boolean if true, localize the results before returning.
- * @param $labelColumnName
- * String the column to use for 'label'.
- *
+ * @param int $id
+ * id of the option group.
+ * @param bool $flip
+ * results are return in id => label format if false.
+ * if true, the results are reversed
+ * @param bool $grouping
+ * if true, return the value in 'grouping' column.
+ * @param bool $localize
+ * if true, localize the results before returning.
+ * @param string $labelColumnName
+ * the column to use for 'label'.
* @param bool $onlyActive
* @param bool $fresh
*
- * @return array the values as specified by the above params
+ * @return array of values as specified by the above params
* @static
* @void
*/
*
* @param array $params
* Reference array of values submitted by the form. Based on.
- * $flip, creates new elements in $params for each field in
- * the $names array.
- * If $flip = false, adds root field name => title
- * If $flip = true, adds actual field name => id
+ * $flip, creates new elements in $params for each field in
+ * the $names array.
+ * If $flip = false, adds root field name => title
+ * If $flip = true, adds actual field name => id
*
* @param array $names
* Reference array of fieldnames we want transformed.
- * Array key = 'postName' (field name submitted by form in $params).
- * Array value = array(
- 'newName' => $newName, 'groupName' => $groupName).
+ * Array key = 'postName' (field name submitted by form in $params).
+ * Array value = array('newName' => $newName, 'groupName' => $groupName).
*
*
* @param bool $flip
/**
* Constructor function
*
- * @param $inputData
- * Array contents of HTTP REQUEST.
+ * @param array $inputData
+ * contents of HTTP REQUEST.
*
* @throws CRM_Core_Exception
*/
/**
* Helper function to convert XML string to multi-dimension array.
*
- * @param $xml
+ * @param string $xml
* an XML string.
*
* @return array An array of the result with following keys:
return $result;
}
- // private helper for xml_parse_into_assoc, to recusively parsing the result
/**
+ * Private helper for xml_parse_into_assoc, to recusively parsing the result
* @param $input
* @param int $depth
*
* Given a state ID return the country ID, this allows
* us to populate forms and values for downstream code
*
- * @param $stateID
- * Int.
+ * @param int $stateID
*
* @return int the country id that the state belongs to
* @static
/**
* Fetch the list of active extensions of type 'module'
*
- * @param $fresh
- * Bool whether to forcibly reload extensions list from canonical store.
+ * @param bool $fresh
+ * Whether to forcibly reload extensions list from canonical store.
* @static
*
* @return array - array(array('prefix' => $, 'file' => $))
* Note: This function does not perform any extra encoding of markup, script code, or etc. If
* you're passing in user-data, you must clean it yourself.
*
- * @param $snippet
+ * @param array $snippet
* Array; keys:.
* - type: string (auto-detected for markup, template, callback, script, scriptUrl, jquery, style, styleUrl)
* - name: string, optional
/**
* Get or set the single instance of CRM_Core_Resources
*
- * @param $instance
- * CRM_Core_Resources, new copy of the manager.
+ * @param CRM_Core_Resources $instance
+ * New copy of the manager.
* @return CRM_Core_Resources
*/
static public function singleton(CRM_Core_Resources $instance = NULL) {
/**
* Add a JavaScript file to the current page using <SCRIPT SRC>.
*
- * @param $ext
- * String, extension name; use 'civicrm' for core.
- * @param $file
- * String, file path -- relative to the extension base dir.
- * @param $weight
- * Int, relative weight within a given region.
- * @param $region
- * String, location within the file; 'html-header', 'page-header', 'page-footer'.
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @param $translate, whether to parse this file for strings enclosed in ts()
*
* @return CRM_Core_Resources
/**
* Add a JavaScript file to the current page using <SCRIPT SRC>.
*
- * @param $url
- * String.
- * @param $weight
- * Int, relative weight within a given region.
- * @param $region
- * String, location within the file; 'html-header', 'page-header', 'page-footer'.
+ * @param string $url
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addScriptUrl($url, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Add a JavaScript file to the current page using <SCRIPT SRC>.
*
- * @param $code
- * String, JavaScript source code.
- * @param $weight
- * Int, relative weight within a given region.
- * @param $region
- * String, location within the file; 'html-header', 'page-header', 'page-footer'.
+ * @param string $code
+ * JavaScript source code.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addScript($code, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
* This function is usually reserved for low-level system use.
* Extensions and components should generally use addVars instead.
*
- * @param $settings
- * Array.
+ * @param array $settings
* @return CRM_Core_Resources
*/
public function addSetting($settings) {
* CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('myString' => ts('Your %1 has been %2', array(subs)))));
* And from javascript access it at CRM.myNamespace.myString
*
- * @param $text
- * String|array.
+ * @param string|array $text
* @return CRM_Core_Resources
*/
public function addString($text) {
/**
* Add a CSS file to the current page using <LINK HREF>.
*
- * @param $ext
- * String, extension name; use 'civicrm' for core.
- * @param $file
- * String, file path -- relative to the extension base dir.
- * @param $weight
- * Int, relative weight within a given region.
- * @param $region
- * String, location within the file; 'html-header', 'page-header', 'page-footer'.
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addStyleFile($ext, $file, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Add a CSS file to the current page using <LINK HREF>.
*
- * @param $url
- * String.
- * @param $weight
- * Int, relative weight within a given region.
- * @param $region
- * String, location within the file; 'html-header', 'page-header', 'page-footer'.
+ * @param string $url
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addStyleUrl($url, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Add a CSS content to the current page using <STYLE>.
*
- * @param $code
- * String, CSS source code.
- * @param $weight
- * Int, relative weight within a given region.
- * @param $region
- * String, location within the file; 'html-header', 'page-header', 'page-footer'.
+ * @param string $code
+ * CSS source code.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addStyle($code, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Determine file path of a resource provided by an extension
*
- * @param $ext
- * String, extension name; use 'civicrm' for core.
- * @param $file
- * String, file path -- relative to the extension base dir.
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
*
* @return bool|string (string|bool), full file path or FALSE if not found
*/
/**
* Determine public URL of a resource provided by an extension
*
- * @param $ext
- * String, extension name; use 'civicrm' for core.
- * @param $file
- * String, file path -- relative to the extension base dir.
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
* @param bool $addCacheCode
*
* @return string, URL
/**
* Translate strings in a javascript file
*
- * @param $ext
- * String, extension name.
- * @param $file
- * String, file path.
+ * @param string $ext
+ * extension name.
+ * @param string $file
+ * file path.
* @return void
*/
private function translateScript($ext, $file) {
/**
* Stores an alert to be displayed to the user via crm-messages
*
- * @param $text
- * String.
+ * @param string $text
* The status message
*
- * @param $title
- * String.
+ * @param string $title
* The optional title of this message
*
- * @param $type
- * String.
+ * @param string $type
* The type of this message (printed as a css class). Possible options:
* - 'alert' (default)
* - 'info'
* until the user dismisses it)
* - 'no-popup' (will display in the document like old-school)
*
- * @param $options
- * Array.
+ * @param array $options
* Additional options. Possible values:
* - 'unique' (default: true) Check if this message was already set before adding
* - 'expires' how long to display this message before fadeout (in ms)
/**
* Get current/future Events
*
- * @param $all
- * Int 0 returns current and future events.
+ * @param int $all
+ * 0 returns current and future events.
* 1 if events all are required
* 2 returns events since 3 months ago
* @param bool|int $id int id of a specific event to return
- * @param $isActive
- * Boolean true if you need only active events.
- * @param $checkPermission
- * Boolean true if you need to check permission else false.
+ * @param bool $isActive
+ * true if you need only active events.
+ * @param bool $checkPermission
+ * true if you need to check permission else false.
*
* @return array
* @static
/**
* Creates or updates a participant payment record
*
- * @param $params
- * Array of values to initialize the record with.
- * @param $ids
- * Array with one values of id for this participantPayment record (for update).
+ * @param array $params
+ * of values to initialize the record with.
+ * @param array $ids
+ * with one values of id for this participantPayment record (for update).
*
* @return object the partcipant payment record
* @static
/* Format user submitted price set params.
* Convert price set each param as an array.
*
- * @param $params
+ * @param array $params
* An array of user submitted params.
*
*
/**
* Fetch the list of active extensions of type 'module'
*
- * @param $fresh
- * Bool whether to forcibly reload extensions list from canonical store.
+ * @param bool $fresh
+ * whether to forcibly reload extensions list from canonical store.
* @return array - array(array('prefix' => $, 'file' => $))
*/
public function getActiveModuleFiles($fresh = FALSE) {
/**
* Set and validate field values
*
- * @param $elements
+ * @param array $elements
* : array.
* @param $erroneousField
* : reference.
/**
* Add missing (potentially specified) log table columns for the given table.
*
- * @param $table
- * String name of the relevant table.
- * @param $cols
+ * @param string $table
+ * name of the relevant table.
+ * @param array $cols
* Mixed array of columns to add or null (to check for the missing columns).
- * @param $rebuildTrigger
- * Boolean should we rebuild the triggers.
+ * @param bool $rebuildTrigger
+ * should we rebuild the triggers.
*
* @return void
*/
/**
* Get the content/components of mailing based on mailing Id
*
- * @param $report
- * Array of mailing report.
+ * @param array $report
+ * of mailing report.
*
* @param $form
* Reference of this.
* If the member & contributor are the same then the values will be the same. But if different people paid
* then they weill differ
*
- * @param $formValues
- * Array values from form. The important values we are looking for are.
+ * @param array $formValues
+ * values from form. The important values we are looking for are.
* - contact_id
* - soft_credit_contact_id
*/
* Given a participant id/contribution id,
* return contribution/fee line items
*
- * @param $entityId
- * Int participant/contribution id.
- * @param $entity
- * String participant/contribution.
+ * @param int $entityId
+ * participant/contribution id.
+ * @param string $entity
+ * participant/contribution.
*
* @param null $isQuick
* @param bool $isQtyZero
/**
* Calculate tax rate in percentage
*
- * @param $lineItemId
+ * @param array $lineItemId
* An assoc array of lineItem.
*
* @return tax rate
/**
* This is some kind of special-purpose router/front-controller for the various profile URLs.
*
- * @param $args
- * Array this array contains the arguments of the url.
+ * @param array $args
+ * this array contains the arguments of the url.
*
* @return string|void
* @static
/**
* Fill the queue with upgrade tasks
*
- * @param $currentVer
- * String, the original revision.
- * @param $latestVer
- * String, the target (final) revision.
- * @param $postUpgradeMessageFile
- * String, path of a modifiable file which lists the post-upgrade messages.
+ * @param string $currentVer
+ * the original revision.
+ * @param string $latestVer
+ * the target (final) revision.
+ * @param string $postUpgradeMessageFile
+ * path of a modifiable file which lists the post-upgrade messages.
*
* @return CRM_Queue
*/
* Perform an incremental version update
*
* @param CRM_Queue_TaskContext $ctx
- * @param $rev
- * String, the target (intermediate) revision e.g '3.2.alpha1'.
+ * @param string $rev
+ * the target (intermediate) revision e.g '3.2.alpha1'.
*
* @return bool
*/
* Perform an incremental version update
*
* @param CRM_Queue_TaskContext $ctx
- * @param $rev
- * String, the target (intermediate) revision e.g '3.2.alpha1'.
- * @param $originalVer
- * String, the original revision.
- * @param $latestVer
- * String, the target (final) revision.
- * @param $postUpgradeMessageFile
- * String, path of a modifiable file which lists the post-upgrade messages.
+ * @param string $rev
+ * the target (intermediate) revision e.g '3.2.alpha1'.
+ * @param string $originalVer
+ * the original revision.
+ * @param string $latestVer
+ * the target (final) revision.
+ * @param string $postUpgradeMessageFile
+ * path of a modifiable file which lists the post-upgrade messages.
*
* @return bool
*/
* Perform an incremental version update
*
* @param CRM_Queue_TaskContext $ctx
- * @param $rev
- * String, the target (intermediate) revision e.g '3.2.alpha1'.
- * @param $currentVer
- * String, the original revision.
- * @param $latestVer
- * String, the target (final) revision.
- * @param $postUpgradeMessageFile
- * String, path of a modifiable file which lists the post-upgrade messages.
+ * @param string $rev
+ * the target (intermediate) revision e.g '3.2.alpha1'.
+ * @param string $currentVer
+ * the original revision.
+ * @param string $latestVer
+ * the target (final) revision.
+ * @param string $postUpgradeMessageFile
+ * path of a modifiable file which lists the post-upgrade messages.
*
* @return bool
*/
* by calling the 'setPreUpgradeMessage' on each incremental upgrade
* object.
*
- * @param $preUpgradeMessage
- * String, alterable.
+ * @param string $preUpgradeMessage
+ * alterable.
* @param $currentVer
* @param $latestVer
*/
/**
* Compute any messages which should be displayed before upgrade
*
- * @param $preUpgradeMessage
- * String, alterable.
+ * @param string $preUpgradeMessage
+ * alterable.
* @param $currentVer
* @param $latestVer
*/
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage
- * String, alterable.
- * @param $rev
- * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+ * @param string $postUpgradeMessage
+ * alterable.
+ * @param string $rev
+ * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public static function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_alpha1($rev) {
for ($stepID = 1; $stepID <= 4; $stepID++) {
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_1_2($rev) {
$formName = "CRM_Upgrade_TwoOne_Form_TwoOneTwo";
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_beta1($rev) {
if (!CRM_Core_DAO::checkFieldExists('civicrm_pcp_block', 'notify_email')) {
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_beta2($rev) {
$template = CRM_Core_Smarty::singleton();
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_beta3($rev) {
$template = CRM_Core_Smarty::singleton();
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_0_alpha1($rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_alpha1($rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_7($rev) {
$upgrade = new CRM_Upgrade_Form();
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_0_2($rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_0_4($rev) {
//make sure 'Deceased' membership status present in db,CRM-5636
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_0($rev) {
// upgrade all roles who have 'access CiviEvent' permission, to also have
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_3($rev) {
$threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
/**
* Perform an incremental upgrade
*
- * @param $rev
- * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
+ * @param string $rev
+ * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_4($rev) {
$threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev
- * String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
+ * @param string $rev
+ * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage
- * String, alterable.
- * @param $rev
- * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+ * @param string $postUpgradeMessage
+ * alterable.
+ * @param string $rev
+ * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
*
*
* @param CRM_Queue_TaskContext $ctx
- * @param $startId
- * Int, the first/lowest entity ID to convert.
- * @param $endId
- * Int, the last/highest entity ID to convert.
+ * @param int $startId
+ * the first/lowest entity ID to convert.
+ * @param int $endId
+ * the last/highest entity ID to convert.
* @param
*
* @return bool
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev
- * String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
+ * @param string $rev
+ * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage
- * String, alterable.
- * @param $rev
- * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+ * @param string $postUpgradeMessage
+ * alterable.
+ * @param string $rev
+ * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage
- * String, alterable.
- * @param $rev
- * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+ * @param string $postUpgradeMessage
+ * alterable.
+ * @param string $rev
+ * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
*
* @return void
*/
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev
- * String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
+ * @param string $rev
+ * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage
- * String, alterable.
- * @param $rev
- * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+ * @param string $postUpgradeMessage
+ * alterable.
+ * @param string $rev
+ * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev
- * String, a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0'.
+ * @param string $rev
+ * a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0'.
* @param null $currentVer
*
* @return void|bool
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage
- * String, alterable.
- * @param $rev
- * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+ * @param string $postUpgradeMessage
+ * alterable.
+ * @param string $rev
+ * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev
- * String, a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0'.
+ * @param string $rev
+ * a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage
- * String, alterable.
- * @param $rev
- * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
+ * @param string $postUpgradeMessage
+ * alterable.
+ * @param string $rev
+ * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* records.
*
* @param CRM_Queue_TaskContext $ctx
- * @param $startId
- * Int, the first/lowest contribution ID to convert.
- * @param $endId
- * Int, the last/highest contribution ID to convert.
+ * @param int $startId
+ * the first/lowest contribution ID to convert.
+ * @param int $endId
+ * the last/highest contribution ID to convert.
*
* @return bool
*/
* records.
*
* @param CRM_Queue_TaskContext $ctx
- * @param $startId
- * Int, the first/lowest participant ID to convert.
- * @param $endId
- * Int, the last/highest participant ID to convert.
+ * @param int $startId
+ * the first/lowest participant ID to convert.
+ * @param int $endId
+ * the last/highest participant ID to convert.
*
* @return bool
*/
* Given a participant id/contribution id,
* return contribution/fee line items
*
- * @param $entityId
- * Int participant/contribution id.
- * @param $entity
- * String participant/contribution.
+ * @param int $entityId
+ * participant/contribution id.
+ * @param string $entity
+ * participant/contribution.
*
* @param null $isQuick
*
/**
* Get the time in UTC for the current time. You can optionally send an offset from the current time if needed
*
- * @param $offset
- * Int the offset from the current time in seconds.
+ * @param int $offset
+ * the offset from the current time in seconds.
*
* @return the time in UTC
* @static
*
* TODO: Automatic file cleanup using, eg, TTL policy
*
- * @param $prefix
- * String.
+ * @param string $prefix
*
* @return string, path to an openable/writable file
* @see tempnam
*
* TODO: Automatic file cleanup using, eg, TTL policy
*
- * @param $prefix
- * String.
+ * @param string $prefix
*
* @return string, path to an openable/writable directory; ends with '/'
* @see tempnam
*
* Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
*
- * @param $dir
- * String, base dir.
- * @param $pattern
- * String, glob pattern, eg "*.txt".
+ * @param string $dir
+ * base dir.
+ * @param string $pattern
+ * glob pattern, eg "*.txt".
* @return array(string)
*/
public static function findFiles($dir, $pattern) {
/**
* Instantiate a signature-processor
*
- * @param $secret
- * String, private.
- * @param $paramNames
+ * @param string $secret
+ * private.
+ * @param array $paramNames
* Array, fields which should be part of the signature.
*/
public function __construct($secret, $paramNames) {
/**
* Generate a signature for a set of key-value pairs
*
- * @param $params
+ * @param array $params
* Array, key-value pairs.
- * @param $salt
- * String, the salt (if known) or NULL (for auto-generated).
+ * @param string $salt
+ * the salt (if known) or NULL (for auto-generated).
* @return string, the full public token representing the signature
*/
public function sign($params, $salt = NULL) {
/**
* Determine whether a token represents a proper signature for $params
*
- * @param $token
- * String, the full public token representing the signature.
- * @param $params
+ * @param string $token
+ * the full public token representing the signature.
+ * @param array $params
* Array, key-value pairs.
*
* @throws Exception
* Add a script file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline script
*
* @param $code: string, javascript code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add a css file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline style
*
* @param $code: string, css code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Find any users/roles/security-principals with the given permission
* and replace it with one or more permissions.
*
- * @param $oldPerm
- * String.
- * @param $newPerms
+ * @param string $oldPerm
+ * @param array $newPerms
* Array, strings.
*
* @return void
* Add a script file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline script
*
* @param $code: string, javascript code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add a css file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline style
*
* @param $code: string, css code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Find any users/roles/security-principals with the given permission
* and replace it with one or more permissions.
*
- * @param $oldPerm
- * String.
- * @param $newPerms
+ * @param string $oldPerm
+ * @param array $newPerms
* Array, strings.
*
* @return void
* Add a script file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline script
*
* @param $code: string, javascript code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add a css file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline style
*
* @param $code: string, css code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
/**
* Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
*
- * @param $path
- * String The path being linked to, such as "civicrm/add".
- * @param $query
- * String A query string to append to the link.
- * @param $absolute
- * Boolean Whether to force the output to be an absolute link (beginning with http:).
+ * @param string $path
+ * The path being linked to, such as "civicrm/add".
+ * @param string $query
+ * A query string to append to the link.
+ * @param bool $absolute
+ * Whether to force the output to be an absolute link (beginning with http:).
* Useful for links that will be displayed outside the site, such as in an
* RSS feed.
- * @param $fragment
- * String A fragment identifier (named anchor) to append to the link.
- * @param $htmlize
- * Boolean whether to convert to html eqivalant.
- * @param $frontend
- * Boolean a gross joomla hack.
- * @param $forceBackend
- * Boolean a gross joomla hack.
+ * @param string $fragment
+ * A fragment identifier (named anchor) to append to the link.
+ * @param bool $htmlize
+ * whether to convert to html eqivalant.
+ * @param bool $frontend
+ * a gross joomla hack.
+ * @param bool $forceBackend
+ * a gross joomla hack.
*
* @return string an HTML string containing a link to the given path.
*
* Find any users/roles/security-principals with the given permission
* and replace it with one or more permissions.
*
- * @param $oldPerm
- * String.
- * @param $newPerms
+ * @param string $oldPerm
+ * @param array $newPerms
* Array, strings.
*
* @return void
* Add a script file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline script
*
* @param $code: string, javascript code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add a css file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline style
*
* @param $code: string, css code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
/**
* Generate an internal CiviCRM URL
*
- * @param $path
- * String The path being linked to, such as "civicrm/add".
- * @param $query
- * String A query string to append to the link.
- * @param $absolute
- * Boolean Whether to force the output to be an absolute link (beginning with http:).
+ * @param string $path
+ * The path being linked to, such as "civicrm/add".
+ * @param string $query
+ * A query string to append to the link.
+ * @param bool $absolute
+ * Whether to force the output to be an absolute link (beginning with http:).
* Useful for links that will be displayed outside the site, such as in an
* RSS feed.
- * @param $fragment
- * String A fragment identifier (named anchor) to append to the link.
- * @param $htmlize
- * Boolean whether to convert to html eqivalant.
- * @param $frontend
- * Boolean a gross joomla hack.
+ * @param string $fragment
+ * A fragment identifier (named anchor) to append to the link.
+ * @param bool $htmlize
+ * whether to convert to html eqivalant.
+ * @param bool $frontend
+ * a gross joomla hack.
*
* @param bool $forceBackend
*
* The user name.
* @param string $password
* The password for the above user name.
- * @param $loadCMSBootstrap
- * Boolean load cms bootstrap?.
+ * @param bool $loadCMSBootstrap
+ * load cms bootstrap?.
*
* @return mixed false if no auth
* array(
/**
* Load joomla bootstrap
*
- * @param $params
- * Array with uid or name and password.
- * @param $loadUser
- * Boolean load cms user?.
+ * @param array $params
+ * with uid or name and password.
+ * @param bool $loadUser
+ * load cms user?.
* @param bool|\throw $throwError throw error on failure?
* @param null $realPath
* @param bool $loadDefines
/**
* Generate an internal CiviCRM URL
*
- * @param $path
- * String The path being linked to, such as "civicrm/add".
- * @param $query
- * String A query string to append to the link.
- * @param $absolute
- * Boolean Whether to force the output to be an absolute link (beginning with http:).
+ * @param string $path
+ * The path being linked to, such as "civicrm/add".
+ * @param string $query
+ * A query string to append to the link.
+ * @param bool $absolute
+ * Whether to force the output to be an absolute link (beginning with http:).
* Useful for links that will be displayed outside the site, such as in an
* RSS feed.
- * @param $fragment
- * String A fragment identifier (named anchor) to append to the link.
+ * @param string $fragment
+ * A fragment identifier (named anchor) to append to the link.
*
* @return string an HTML string containing a link to the given path.
*
/**
* Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
*
- * @param $path
- * String The path being linked to, such as "civicrm/add".
- * @param $query
- * String A query string to append to the link.
- * @param $absolute
- * Boolean Whether to force the output to be an absolute link (beginning with http:).
+ * @param string $path
+ * The path being linked to, such as "civicrm/add".
+ * @param string $query
+ * A query string to append to the link.
+ * @param bool $absolute
+ * Whether to force the output to be an absolute link (beginning with http:).
* Useful for links that will be displayed outside the site, such as in an
* RSS feed.
- * @param $fragment
- * String A fragment identifier (named anchor) to append to the link.
- * @param $htmlize
- * Boolean whether to convert to html eqivalant.
- * @param $frontend
- * Boolean a gross joomla hack.
- * @param $forceBackend
- * Boolean a gross joomla hack.
+ * @param string $fragment
+ * A fragment identifier (named anchor) to append to the link.
+ * @param bool $htmlize
+ * whether to convert to html eqivalant.
+ * @param bool $frontend
+ * a gross joomla hack.
+ * @param bool $forceBackend
+ * a gross joomla hack.
*
* @return string an HTML string containing a link to the given path.
*
* Add a script file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline script
*
* @param $code: string, javascript code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add a css file
*
* @param $url: string, absolute path to file
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline style
*
* @param $code: string, css code
- * @param $region
- * String, location within the document: 'html-header', 'page-header', 'page-footer'.
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
/**
* Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
*
- * @param $path
- * String The path being linked to, such as "civicrm/add".
- * @param $query
- * String A query string to append to the link.
- * @param $absolute
- * Boolean Whether to force the output to be an absolute link (beginning with http:).
+ * @param string $path
+ * The path being linked to, such as "civicrm/add".
+ * @param string $query
+ * A query string to append to the link.
+ * @param bool $absolute
+ * Whether to force the output to be an absolute link (beginning with http:).
* Useful for links that will be displayed outside the site, such as in an
* RSS feed.
- * @param $fragment
- * String A fragment identifier (named anchor) to append to the link.
- * @param $htmlize
- * Boolean whether to convert to html eqivalant.
- * @param $frontend
- * Boolean a gross joomla hack.
+ * @param string $fragment
+ * A fragment identifier (named anchor) to append to the link.
+ * @param bool $htmlize
+ * whether to convert to html eqivalant.
+ * @param bool $frontend
+ * a gross joomla hack.
*
* @param bool $forceBackend
*
/**
* Load wordpress bootstrap
*
- * @param $name
- * String optional username for login.
- * @param $pass
- * String optional password for login.
+ * @param string $name
+ * optional username for login.
+ * @param string $pass
+ * optional password for login.
*
* @return bool
*/
/**
* Get array of string tokens
*
- * @param $string
+ * @param string $string
* The input string to parse for tokens.
*
* @return array $tokens array of tokens mentioned in field@access public
* An inefficient helper for creating a ZIP file from data in memory.
* This is only intended for building temp files for unit-testing.
*
- * @param $zipName
- * String, file name.
- * @param $dirs
+ * @param string $zipName
+ * file name.
+ * @param array $dirs
* Array, list of directory paths.
- * @param $files
+ * @param array $files
* Array, keys are file names and values are file contents.
* @return bool
*/
* Create a contact and perform a series of steps with it; after each
* step, ensure that the contact's modified_date has increased.
*
- * @param $callbacks
- * Array ($name => $callable).
+ * @param array $callbacks
+ * ($name => $callable).
*/
public function _testTimestamps($callbacks) {
CRM_Core_DAO::triggerRebuild();
/**
* Assert that the cache for a group contains exactly the listed contacts
*
- * @param $expectedContactIds
+ * @param array $expectedContactIds
* Array(int).
- * @param $groupId
- * Int.
+ * @param int $groupId
*/
public function assertCacheMatches($expectedContactIds, $groupId) {
$sql = 'SELECT contact_id FROM civicrm_group_contact_cache WHERE group_id = %1';
}
/**
- * @param $objects
- * Array DAO or BAO objects.
+ * @param array $objects
+ * DAO or BAO objects.
*/
public function registerTestObjects($objects) {
//if (is_object($objects)) {
}
/**
- * @param $objects
- * Array DAO or BAO objects.
+ * @param array $objects
+ * DAO or BAO objects.
*/
public function registerTestObjects($objects) {
//if (is_object($objects)) {
/**
* @param $input
- * @param $expected
- * Bool.
- * @dataProvider booleanDataProvider
+ * @param bool $expected
+ * * @dataProvider booleanDataProvider
*/
public function testStrToBool($input, $expected) {
$actual = CRM_Utils_String::strtobool($input);
/**
* Open an internal path beginning with 'civicrm/'
*
- * @param $url
- * (str) omit the 'civicrm/' it will be added for you.
- * @param $args
- * (str|array) optional url arguments.
+ * @param string $url
+ * omit the 'civicrm/' it will be added for you.
+ * @param string|array $args
+ * optional url arguments.
* @param $waitFor
* Page element to wait for - using this is recommended to ensure the document is fully loaded.
*
/**
* Create new relationship type w/ user specified params or default.
*
- * @param $params
- * Array of required params.
+ * @param array $params
+ * of required params.
*
* @return an array of saved params values.
*/
*
* @param string $function
* __FUNCTION__.
- * @param $filename
- * String $file __FILE__.
+ * @param string $filename
+ * $file __FILE__.
*
* @return array $ids ids of created objects
*/
/**
* Click on an inline-edit block and wait for it to open
*
- * @param $block
- * String selector.
+ * @param string $block
+ * selector.
* @param bool $wait
*/
private function openInlineForm($block, $wait = TRUE) {
/**
* Enter values in an inline edit block and save
*
- * @param $block
- * String selector.
- * @param $params
- * Array.
+ * @param string $block
+ * selector.
+ * @param array $params
* @param \str|string $valid str: submit behavior
* 'error' if we are expecting a form validation error,
* 're_open' (default) after saving, opens the form and validate inputs
/**
* Require once Files
- * @param $files
- * Array list of files to load.
+ * @param array $files
+ * list of files to load.
*/
public function requireOnceFilesArray($files) {
foreach ($files as $key => $file) {
projects / civicrm-core.git / commitdiff