INFRA-132 - Put space after flow-control (if/switch/for/foreach/while)
[civicrm-core.git] / CRM / Contact / Form / Edit / Address.php
index 676c4282e5822c78355ed3708747c8e00bd2f894..cdfaeef9c731bda5eb2032917f7ca26af49a6390 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
 class CRM_Contact_Form_Edit_Address {
 
   /**
-   * build form for address input fields
+   * Build form for address input fields
    *
-   * @param object  $form - CRM_Core_Form (or subclass)
-   * @param int     $addressBlockCount - the index of the address array (if multiple addresses on a page)
-   * @param boolean $sharing - false, if we want to skip the address sharing features
-   * @param boolean $inlineEdit true when edit used in inline edit
+   * @param CRM_Core_Form $form
+   * @param int $addressBlockCount
+   *   The index of the address array (if multiple addresses on a page).
+   * @param bool $sharing
+   *   False, if we want to skip the address sharing features.
+   * @param bool $inlineEdit
+   *   True when edit used in inline edit.
    *
    * @return void
    *
-   * @access public
    * @static
    */
-  static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharing = TRUE, $inlineEdit = FALSE) {
+  public static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharing = TRUE, $inlineEdit = FALSE) {
     // passing this via the session is AWFUL. we need to fix this
     if (!$addressBlockCount) {
       $blockId = ($form->get('Address_Block_Count')) ? $form->get('Address_Block_Count') : 1;
@@ -253,22 +255,17 @@ class CRM_Contact_Form_Edit_Address {
   }
 
   /**
-   * check for correct state / country mapping.
+   * Check for correct state / country mapping.
    *
    * @param $fields
    * @param $files
    * @param $self
    *
-   * @internal param \reference $array $fields - submitted form values.
-   * @internal param \reference $array $errors - if any errors found add to this array. please.
+   * @return array|bool if no errors
    *
-   * @return true if no errors
-   *         array of errors if any present.
-   *
-   * @access public
    * @static
    */
-  static function formRule($fields, $files, $self) {
+  public static function formRule($fields, $files, $self) {
     $errors = array();
 
     $customDataRequiredFields = array();
@@ -283,7 +280,7 @@ class CRM_Contact_Form_Edit_Address {
           // DETACH 'required' form rule error to
           // custom data only if address data not exists upon submission
           if (!empty($customDataRequiredFields)) {
-            foreach($customDataRequiredFields as $customElementName) {
+            foreach ($customDataRequiredFields as $customElementName) {
               $elementName = "address[$instance][$customElementName]";
               if ($self->getElementError($elementName)) {
                 // set element error to none
@@ -297,7 +294,7 @@ class CRM_Contact_Form_Edit_Address {
         // DETACH 'required' form rule error to
         // custom data only if address data not exists upon submission
         if (!empty($customDataRequiredFields) && !CRM_Core_BAO_Address::dataExists($addressValues)) {
-          foreach($customDataRequiredFields as $customElementName) {
+          foreach ($customDataRequiredFields as $customElementName) {
             $elementName = "address[$instance][$customElementName]";
             if ($self->getElementError($elementName)) {
               // set element error to none
@@ -316,15 +313,16 @@ class CRM_Contact_Form_Edit_Address {
   }
 
   /**
-   * function to set default values for address block
+   * Set default values for address block
    *
-   * @param array  $defaults  defaults associated array
-   * @param object $form     form object
+   * @param array $defaults
+   *   Defaults associated array.
+   * @param CRM_Core_Form $form
+   *   Form object.
    *
    * @static
-   * @access public
    */
-  static function setDefaultValues( &$defaults, &$form ) {
+  public static function setDefaultValues( &$defaults, &$form ) {
     $addressValues = array();
     if (isset($defaults['address']) && is_array($defaults['address']) &&
       !CRM_Utils_System::isNull($defaults['address'])
@@ -419,10 +417,10 @@ class CRM_Contact_Form_Edit_Address {
 
 
   /**
-   * @param $form
+   * @param CRM_Core_Form $form
    * @param $groupTree
    */
-  static function storeRequiredCustomDataInfo(&$form, $groupTree) {
+  public static function storeRequiredCustomDataInfo(&$form, $groupTree) {
     if (CRM_Utils_System::getClassName($form) == 'CRM_Contact_Form_Contact') {
       $requireOmission = NULL;
       foreach ($groupTree as $csId => $csVal) {