<?php
-/*
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
/**
* Create or update a loc_block
*
- * @param array $params Associative array of property
+ * @param array $params
+ * Associative array of property.
* name/value pairs to insert in new 'loc_block'
* @example LocBlockCreate.php Std Create example
*
- * @return array api result array
- * {@getfields loc_block_create}
- * @access public
+ * @return array
+ * api result array
+ * {@getfields loc_block_create}
*/
function civicrm_api3_loc_block_create($params) {
$entities = array();
/**
* Returns array of loc_blocks matching a set of one or more properties
*
- * @param array $params Array of one or more valid property_name=>value pairs. If $params is set
- * as null, all loc_blocks will be returned (default limit is 25)
+ * @param array $params
+ * Array of one or more valid property_name=>value pairs. If $params is set.
+ * as null, all loc_blocks will be returned (default limit is 25)
*
- * @return array Array of matching loc_blocks
- * {@getfields loc_block_get}
- * @access public
+ * @return array
+ * Array of matching loc_blocks
+ * {@getfields loc_block_get}
*/
function civicrm_api3_loc_block_get($params) {
$options = _civicrm_api3_get_options_from_params($params);
* This method is used to delete any existing loc_block.
* id of the record to be deleted is required field in $params array
*
- * @param array $params array containing id of the record to be deleted
+ * @param array $params
+ * Array containing id of the record to be deleted.
*
- * @return array returns flag true if successfull, error message otherwise
- * {@getfields loc_block_delete}
- * @access public
+ * @return array
+ * API result array
+ * {@getfields loc_block_delete}
*/
function civicrm_api3_loc_block_delete($params) {
return _civicrm_api3_basic_delete('CRM_Core_DAO_LocBlock', $params);