Merge remote-tracking branch 'upstream/4.4' into 4.4-4.5-2014-10-14-11-16-10

[civicrm-core.git] / CRM / Utils / API / AbstractFieldCoder.php

diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php
index c656d15f88a1a854e0a9bea910517fe270f7d3ed..8846c6bd85c2fbaa0123007d996a439efdd6f0ae 100644 (file)
--- a/CRM/Utils/API/AbstractFieldCoder.php
+++ b/CRM/Utils/API/AbstractFieldCoder.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -30,12 +30,16 @@
  * of all fields (except for some black-listed skip-fields).
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
 
 require_once 'api/Wrapper.php';
+
+/**
+ * Class CRM_Utils_API_AbstractFieldCoder
+ */
 abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
 
   /**
@@ -81,6 +85,11 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
    */
   public abstract function encodeInput(&$values);
 
+  /**
+   * @param $values
+   *
+   * @return mixed
+   */
   public abstract function decodeOutput(&$values);
 
   /**
@@ -127,6 +136,8 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   }
 
   /**
+   * @param $key
+   *
    * @return bool
    */
   protected function isApiControlField($key) {