| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
/**
- * Static holder for the PDF Page Formats Option Group ID
+ * Static holder for the PDF Page Formats Option Group ID.
*/
private static $_gid = NULL;
/**
* Get page orientations recognized by the DOMPDF package used to create PDF letters.
*
- * @param void
- *
* @return array
* array of page orientations
*/
/**
* Get measurement units recognized by the DOMPDF package used to create PDF letters.
*
- * @param void
- *
* @return array
* array of measurement units
*/
}
/**
- * Get Option Group ID for PDF Page Formats
- *
- * @param void
+ * Get Option Group ID for PDF Page Formats.
*
* @return int
* Group ID (null if Group ID doesn't exist)
}
/**
- * Add ordering fields to Page Format list
+ * Add ordering fields to Page Format list.
*
* @param array (reference) $list List of PDF Page Formats
* @param string $returnURL
* URL of page calling this function.
*
* @return void
- * @static
*/
public static function addOrder(&$list, $returnURL) {
$filter = "option_group_id = " . self::_getGid();
*
* @return array
* (reference) PDF Page Format list
- * @static
*/
public static function &getList($namesOnly = FALSE) {
static $list = array();
}
/**
- * Get the default PDF Page Format values
- *
- * @param NULL
+ * Get the default PDF Page Format values.
*
* @return array
* Name/value pairs containing the default PDF Page Format values.
- * @static
*/
public static function &getDefaultValues() {
$params = array('is_active' => 1, 'is_default' => 1);
}
/**
- * Get PDF Page Format from the DB
+ * Get PDF Page Format from the DB.
*
* @param string $field
* Field name to search by.
}
/**
- * Get PDF Page Format by Name
+ * Get PDF Page Format by Name.
*
* @param int $name
* PDF Page Format name. Empty = get default PDF Page Format.
}
/**
- * Get PDF Page Format by ID
+ * Get PDF Page Format by ID.
*
* @param int $id
* PDF Page Format id. 0 = get default PDF Page Format.
}
/**
- * Get PDF Page Format field from associative array
+ * Get PDF Page Format field from associative array.
*
* @param string $field
* Name of a PDF Page Format field.
* @param null $default
*
* @return value
- * @static
*/
public static function getValue($field, &$values, $default = NULL) {
if (array_key_exists($field, self::$optionValueFields)) {
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * format 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.
* (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Core_DAO_OptionValue
- * @static
*/
public static function retrieve(&$params, &$values) {
$optionValue = new CRM_Core_DAO_OptionValue();
}
/**
- * Save the PDF Page Format in the DB
+ * Save the PDF Page Format in the DB.
*
* @param array (reference) $values associative array of name/value pairs
* @param int $id
}
/**
- * Delete a PDF Page Format
+ * Delete a PDF Page Format.
*
* @param int $id
* ID of the PDF Page Format to be deleted.
*
- * @static
*/
public static function del($id) {
if ($id) {
}
CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
}
+
}