X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FOptionValue.php;h=a47e8ebed57169c989284a1e09473aee5db73acf;hb=00cb6250d344a4de5ecd69c2253785a0767c4b38;hp=0a7130b820ceb13d3533dd7b8368a503f987e94c;hpb=bf392b2f69ca864414f7a610c5010c73a25babb7;p=civicrm-core.git

diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php
index 0a7130b820..a47e8ebed5 100644
--- a/api/v3/OptionValue.php
+++ b/api/v3/OptionValue.php
@@ -1,16 +1,44 @@
 <?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
 
 /**
- * Retrieve one or more OptionValues
+ * This api exposes CiviCRM option values.
+ * Values are grouped by "OptionGroup"
  *
- * @param array $params
+ * @package CiviCRM_APIv3
+ */
+
+/**
+ * Retrieve one or more option values.
  *
- * {@example OptionValueGet.php 0}
- * @example OptionValueGet.php
+ * @param array $params
  *
- * @return  array details of found Option Values
- * {@getfields OptionValue_get}
- * @access public
+ * @return array
+ *   Details of found Option Values
  */
 function civicrm_api3_option_value_get($params) {
 
@@ -27,18 +55,13 @@ function civicrm_api3_option_value_get($params) {
 }
 
 /**
- *  Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
- *
- * Allowed @params array keys are:
- *
- * {@example OptionValueCreate.php}
+ * Add an OptionValue.
  *
  * @param array $params
  *
  * @throws API_Exception
- * @return array of newly created option_value property values.
- * {@getfields OptionValue_create}
- * @access public
+ * @return array
+ *   Array of newly created option_value property values.
  */
 function civicrm_api3_option_value_create($params) {
   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -56,11 +79,12 @@ function civicrm_api3_option_value_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_option_value_create_spec(&$params) {
   $params['is_active']['api.default'] = 1;
@@ -71,24 +95,21 @@ function _civicrm_api3_option_value_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing OptionValue
+ * Deletes an existing option value.
  *
  * @param array $params
  *
- * {@example OptionValueDelete.php 0}
- *
- * @return array Api result
- * {@getfields OptionValue_create}
- * @access public
+ * @return array
+ *   Api result
  */
 function civicrm_api3_option_value_delete($params) {
-  // we will get the option group id before deleting so we can flush pseudoconstants
+  // We will get the option group id before deleting so we can flush pseudoconstants.
   $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
   if (CRM_Core_BAO_OptionValue::del((int) $params['id'])) {
     civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
     return civicrm_api3_create_success();
   }
-  else{
+  else {
     civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']);
   }
 }