| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
/**
- * Static holder for the Label Formats Option Group ID
+ * Static holder for the Label Formats Option Group ID.
*/
private static $_gid = NULL;
}
/**
- * Get Option Group ID for Label Formats
+ * Get Option Group ID for Label Formats.
*
* @param string $name
*
}
/**
- * Add ordering fields to Label Format list
+ * Add ordering fields to Label Format list.
*
* @param array (reference) $list List of Label Formats
* @param string $returnURL
}
/**
- * Retrieve the default Label Format values
+ * Retrieve the default Label Format values.
*
* @param string $groupName
* Label format group name.
}
/**
- * Get Label Format from the DB
+ * Get Label Format from the DB.
*
* @param string $field
* Field name to search by.
}
/**
- * Get Label Format by Name
+ * Get Label Format by Name.
*
* @param int $name
* Label format name. Empty = get default label format.
}
/**
- * Get Label Format by ID
+ * Get Label Format by ID.
*
* @param int $id
* Label format id. 0 = get default label format.
}
/**
- * Get Label Format field from associative array
+ * Get Label Format field from associative array.
*
* @param string $field
* Name of a label format field.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * label id. It also stores all the retrieved values in the default array.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Return the name of the group for customized labels
+ * Return the name of the group for customized labels.
*
* @return void
*/
}
/**
- * Save the Label Format in the DB
+ * Save the Label Format in the DB.
*
* @param array (reference) $values associative array of name/value pairs
* @param int $id
}
/**
- * Delete a Label Format
+ * Delete a Label Format.
*
* @param int $id
* ID of the label format to be deleted.
}
CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
}
+
}