INFRA-132 - CRM/Core - Misc
[civicrm-core.git] / CRM / Core / Form / Tag.php
index 597c3beae0cdee3d291af0745ce064395ebef023..97a0a616d0734efce5738e844914721ffab29c45 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -41,22 +41,28 @@ class CRM_Core_Form_Tag {
   public $_entityTagValues;
 
   /**
-   * Function to build tag widget if correct parent is passed
+   * Build tag widget if correct parent is passed
    *
-   * @param CRM_Core_Form $form form object
-   * @param string $parentNames parent name ( tag name)
-   * @param string $entityTable entitytable 'eg: civicrm_contact'
-   * @param int $entityId entityid  'eg: contact id'
-   * @param boolean $skipTagCreate true if tag need be created using ajax
-   * @param boolean $skipEntityAction true if need to add entry in entry table via ajax
-   * @param string $tagsetElementName if you need to create tagsetlist with specific name
+   * @param CRM_Core_Form $form
+   *   Form object.
+   * @param string $parentNames
+   *   Parent name ( tag name).
+   * @param string $entityTable
+   *   Entitytable 'eg: civicrm_contact'.
+   * @param int $entityId
+   *   Entityid 'eg: contact id'.
+   * @param bool $skipTagCreate
+   *   True if tag need be created using ajax.
+   * @param bool $skipEntityAction
+   *   True if need to add entry in entry table via ajax.
+   * @param string $tagsetElementName
+   *   If you need to create tagsetlist with specific name.
    *
-   * @internal param bool $searchMode true if widget is used in search eg: advanced search
    * @return void
-   * @access public
    * @static
    */
-  static function buildQuickForm(&$form, $parentNames, $entityTable, $entityId = NULL, $skipTagCreate = FALSE,
+  static function buildQuickForm(
+    &$form, $parentNames, $entityTable, $entityId = NULL, $skipTagCreate = FALSE,
     $skipEntityAction = FALSE, $tagsetElementName = NULL ) {
     $tagset = $form->_entityTagValues = array();
     $form->assign("isTagset", FALSE);
@@ -117,18 +123,21 @@ class CRM_Core_Form_Tag {
   }
 
   /**
-   * Function to save entity tags when it is not save used AJAX
+   * Save entity tags when it is not save used AJAX
    *
-   * @param array   $params      associated array
-   * @param int     $entityId    entity id, eg: contact id, activity id, case id, file id
-   * @param string  $entityTable entity table
-   * @param object  $form        form object
+   * @param array $params
+   *   Associated array.
+   * @param int $entityId
+   *   Entity id, eg: contact id, activity id, case id, file id.
+   * @param string $entityTable
+   *   Entity table.
+   * @param CRM_Core_Form $form
+   *   Form object.
    *
    * @return void
-   * @access public
    * @static
    */
-  static function postProcess(&$params, $entityId, $entityTable = 'civicrm_contact', &$form) {
+  public static function postProcess(&$params, $entityId, $entityTable = 'civicrm_contact', &$form) {
     if ($form && !empty($form->_entityTagValues)) {
       $existingTags = $form->_entityTagValues;
     }
@@ -189,4 +198,3 @@ class CRM_Core_Form_Tag {
     }
   }
 }
-