Merge pull request #5252 from JKingsnorth/CRM-10551
[civicrm-core.git] / CRM / Admin / Form / MailSettings.php
index d35174fe486859f81315e1d326c9e47f7d000135..21f6a7ec1a227d4242b7514c94a47aa92ee4b057 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
 class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
 
   /**
-   * Build the form object
+   * Build the form object.
    *
    * @return void
-   * @access public
    */
   public function buildQuickForm() {
     parent::buildQuickForm();
@@ -85,16 +84,16 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
 
     $this->add('checkbox', 'is_ssl', ts('Use SSL?'));
 
-    $usedfor = array(1 => ts('Bounce Processing'),
+    $usedfor = array(
+      1 => ts('Bounce Processing'),
       0 => ts('Email-to-Activity Processing'),
     );
     $this->add('select', 'is_default', ts('Used For?'), $usedfor);
   }
 
   /**
-   * Add local and global form rules
+   * Add local and global form rules.
    *
-   * @access protected
    *
    * @return void
    */
@@ -103,13 +102,13 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
   }
 
   /**
-   * Global validation rules for the form
+   * Global validation rules for the form.
    *
-   * @param array $fields posted values of the form
+   * @param array $fields
+   *   Posted values of the form.
    *
-   * @return array list of errors to be posted back to the form
-   * @static
-   * @access public
+   * @return array
+   *   list of errors to be posted back to the form
    */
   public static function formRule($fields) {
     $errors = array();
@@ -122,9 +121,8 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
   }
 
   /**
-   * Process the form submission
+   * Process the form submission.
    *
-   * @access public
    *
    * @return void
    */
@@ -157,7 +155,9 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
     $params = array();
     foreach ($fields as $f) {
       if (in_array($f, array(
-        'is_default', 'is_ssl'))) {
+        'is_default',
+        'is_ssl',
+      ))) {
         $params[$f] = CRM_Utils_Array::value($f, $formValues, FALSE);
       }
       else {
@@ -185,4 +185,3 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
   }
 
 }
-