/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return object CRM_Core_DAO_Tag object on success, otherwise null
* @static
*
* @return array
*/
- public static function getTagsUsedFor($usedFor = array('civicrm_contact'),
+ public static function getTagsUsedFor($usedFor = array(
+ 'civicrm_contact'),
$buildSelect = TRUE,
- $all = FALSE,
- $parentId = NULL
+ $all = FALSE,
+ $parentId = NULL
) {
$tags = array();
/**
* Function to retrieve tags
*
- * @param string $usedFor which type of tag entity
- * @param array $tags tags array
- * @param int $parentId parent id if you want need only children
- * @param string $separator separator to indicate children
- * @param boolean $formatSelectable add special property for non-selectable
+ * @param string $usedFor
+ * Which type of tag entity.
+ * @param array $tags
+ * Tags array.
+ * @param int $parentId
+ * Parent id if you want need only children.
+ * @param string $separator
+ * Separator to indicate children.
+ * @param bool $formatSelectable
+ * Add special property for non-selectable.
* tag, so they cannot be selected
*
* @return array
*/
- static function getTags($usedFor = 'civicrm_contact',
+ static function getTags(
+ $usedFor = 'civicrm_contact',
&$tags = array(),
- $parentId = NULL,
+ $parentId = NULL,
$separator = ' ',
$formatSelectable = FALSE
) {
$formattedTags = array();
foreach ($tags as $key => $tag) {
if (!empty($tag[2])) {
- $key = $tag[2]. "-" . $key;
+ $key = $tag[2] . "-" . $key;
}
$formattedTags[$key] = $tag[0] . $tag[1];
}
/**
* Delete the tag
*
- * @param int $id tag id
+ * @param int $id
+ * Tag id.
*
* @return boolean
* @static
* contact object. the params array could contain additional unused name/value
* pairs
*
- * @param array $params (reference) an assoc array of name/value pairs
- * @param array $ids (optional) the array that holds all the db ids - we are moving away from this in bao
+ * @param array $params
+ * (reference) an assoc array of name/value pairs.
+ * @param array $ids
+ * (optional) the array that holds all the db ids - we are moving away from this in bao.
* signatures
*
* @return object CRM_Core_DAO_Tag object on success, otherwise null
// if we modify parent tag, then we need to update all children
if ($tag->parent_id === 'null') {
CRM_Core_DAO::executeQuery("UPDATE civicrm_tag SET used_for=%1 WHERE parent_id = %2",
- array(1 => array($params['used_for'], 'String'),
+ array(
+ 1 => array($params['used_for'], 'String'),
2 => array($tag->id, 'Integer'),
)
);
/**
* Check if there is data to create the object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return boolean
* @static
/**
* Get the tag sets for a entity object
*
- * @param string $entityTable entity_table
+ * @param string $entityTable
+ * Entity_table.
*
* @return array $tagSets array of tag sets
* @static
/**
* Get the tags that are not children of a tagset.
*
- * @return array $tags associated array of tag name and id@access public
+ * @return array $tags associated array of tag name and id
+ * @access public
* @static
*/
public static function getTagsNotInTagset() {
return $tags;
}
}
-