X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FUtils%2FAPI%2FAbstractFieldCoder.php;h=d4efe23d1664e5267ba64d26275a1f707b39aeb7;hb=8671b4f2efb228dc654123b391fd794b23b99d49;hp=fa679d3d380a431a154ddc224bf69020a6c9b1b1;hpb=0554664067cdf3fb0f8e9210481a3346b905394a;p=civicrm-core.git

diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php
index fa679d3d38..d4efe23d16 100644
--- a/CRM/Utils/API/AbstractFieldCoder.php
+++ b/CRM/Utils/API/AbstractFieldCoder.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * Base class for writing API_Wrappers which generically manipulate the content
@@ -36,6 +36,10 @@
  */
 
 require_once 'api/Wrapper.php';
+
+/**
+ * Class CRM_Utils_API_AbstractFieldCoder
+ */
 abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
 
   /**
@@ -47,7 +51,8 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
 
   /**
    * @param string $fldName
-   * @return bool TRUE if encoding should be skipped for this field
+   * @return bool
+   *   TRUE if encoding should be skipped for this field
    */
   public function isSkippedField($fldName) {
     $skipFields = $this->getSkipFields();
@@ -74,17 +79,22 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   }
 
   /**
-   * This function is going to filter the
+   * going to filter the
    * submitted values.
    *
    * @param array|string $values the field value from the API
    */
   public abstract function encodeInput(&$values);
 
+  /**
+   * @param $values
+   *
+   * @return mixed
+   */
   public abstract function decodeOutput(&$values);
 
   /**
-   * {@inheritDoc}
+   * @inheritDoc
    */
   public function fromApiInput($apiRequest) {
     $lowerAction = strtolower($apiRequest['action']);
@@ -109,7 +119,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   }
 
   /**
-   * {@inheritDoc}
+   * @inheritDoc
    */
   public function toApiOutput($apiRequest, $result) {
     $lowerAction = strtolower($apiRequest['action']);
@@ -134,4 +144,5 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   protected function isApiControlField($key) {
     return (FALSE !== strpos($key, '.'));
   }
+
 }