X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FDAO%2FMailSettings.php;h=3b1964d6fe5a47d6b2bd4979436c71e1f6969092;hb=bfd5da64bde46b359a0d9195c0a30364ff277f58;hp=10b2a914df47ad80d232acc31a1470ff6598e952;hpb=3f8f03061baa434f3bccd999d9fdc31029d30e39;p=civicrm-core.git

diff --git a/CRM/Core/DAO/MailSettings.php b/CRM/Core/DAO/MailSettings.php
index 10b2a914df..3b1964d6fe 100644
--- a/CRM/Core/DAO/MailSettings.php
+++ b/CRM/Core/DAO/MailSettings.php
@@ -1,29 +1,5 @@
 <?php
-/*
-+--------------------------------------------------------------------+
-| CiviCRM version 4.7                                                |
-+--------------------------------------------------------------------+
-| Copyright CiviCRM LLC (c) 2004-2017                                |
-+--------------------------------------------------------------------+
-| This file is a part of CiviCRM.                                    |
-|                                                                    |
-| CiviCRM is free software; you can copy, modify, and distribute it  |
-| under the terms of the GNU Affero General Public License           |
-| Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
-|                                                                    |
-| CiviCRM is distributed in the hope that it will be useful, but     |
-| WITHOUT ANY WARRANTY; without even the implied warranty of         |
-| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
-| See the GNU Affero General Public License for more details.        |
-|                                                                    |
-| You should have received a copy of the GNU Affero General Public   |
-| License and the CiviCRM Licensing Exception along                  |
-| with this program; if not, contact CiviCRM LLC                     |
-| at info[AT]civicrm[DOT]org. If you have questions about the        |
-| 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-2017
@@ -32,175 +8,194 @@
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  * (GenCodeChecksum:86515d7cb55425fbad3a71d5aa000af0)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_Core_DAO_MailSettings constructor.
+ * Database access object for the MailSettings entity.
  */
 class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_mail_settings';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = false;
+  static $_log = FALSE;
+
   /**
    * primary key
    *
    * @var int unsigned
    */
   public $id;
+
   /**
    * Which Domain is this match entry for
    *
    * @var int unsigned
    */
   public $domain_id;
+
   /**
    * name of this group of settings
    *
    * @var string
    */
   public $name;
+
   /**
    * whether this is the default set of settings for this domain
    *
    * @var boolean
    */
   public $is_default;
+
   /**
    * email address domain (the part after @)
    *
    * @var string
    */
   public $domain;
+
   /**
    * optional local part (like civimail+ for addresses like civimail+s.1.2@example.com)
    *
    * @var string
    */
   public $localpart;
+
   /**
    * contents of the Return-Path header
    *
    * @var string
    */
   public $return_path;
+
   /**
    * name of the protocol to use for polling (like IMAP, POP3 or Maildir)
    *
    * @var string
    */
   public $protocol;
+
   /**
    * server to use when polling
    *
    * @var string
    */
   public $server;
+
   /**
    * port to use when polling
    *
    * @var int unsigned
    */
   public $port;
+
   /**
    * username to use when polling
    *
    * @var string
    */
   public $username;
+
   /**
    * password to use when polling
    *
    * @var string
    */
   public $password;
+
   /**
    * whether to use SSL or not
    *
    * @var boolean
    */
   public $is_ssl;
+
   /**
    * folder to poll from when using IMAP, path to poll from when using Maildir, etc.
    *
    * @var string
    */
   public $source;
+
   /**
    * Name of status to use when creating email to activity.
    *
    * @var string
    */
   public $activity_status;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_mail_settings';
     parent::__construct();
   }
+
   /**
    * Returns foreign keys and entity references.
    *
    * @return array
    *   [CRM_Core_Reference_Interface]
    */
-  static function getReferenceColumns() {
+  public static function getReferenceColumns() {
     if (!isset(Civi::$statics[__CLASS__]['links'])) {
       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
-      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id');
       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
     }
     return Civi::$statics[__CLASS__]['links'];
   }
+
   /**
    * Returns all the column names of this table
    *
    * @return array
    */
-  static function &fields() {
+  public static function &fields() {
     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
-      Civi::$statics[__CLASS__]['fields'] = array(
-        'id' => array(
+      Civi::$statics[__CLASS__]['fields'] = [
+        'id' => [
           'name' => 'id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Mail Settings ID') ,
+          'title' => ts('Mail Settings ID'),
           'description' => 'primary key',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_mail_settings',
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'domain_id' => array(
+        ],
+        'domain_id' => [
           'name' => 'domain_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Mail Settings Domain') ,
+          'title' => ts('Mail Settings Domain'),
           'description' => 'Which Domain is this match entry for',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_mail_settings',
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
           'FKClassName' => 'CRM_Core_DAO_Domain',
-          'pseudoconstant' => array(
+          'pseudoconstant' => [
             'table' => 'civicrm_domain',
             'keyColumn' => 'id',
             'labelColumn' => 'name',
-          )
-        ) ,
-        'name' => array(
+          ]
+        ],
+        'name' => [
           'name' => 'name',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Mail Settings Name') ,
+          'title' => ts('Mail Settings Name'),
           'description' => 'name of this group of settings',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -208,21 +203,21 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'is_default' => array(
+        ],
+        'is_default' => [
           'name' => 'is_default',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Is Default Mail Settings?') ,
+          'title' => ts('Is Default Mail Settings?'),
           'description' => 'whether this is the default set of settings for this domain',
           'table_name' => 'civicrm_mail_settings',
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'domain' => array(
+        ],
+        'domain' => [
           'name' => 'domain',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('email Domain') ,
+          'title' => ts('email Domain'),
           'description' => 'email address domain (the part after @)',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -230,11 +225,11 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'localpart' => array(
+        ],
+        'localpart' => [
           'name' => 'localpart',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('email Local Part') ,
+          'title' => ts('email Local Part'),
           'description' => 'optional local part (like civimail+ for addresses like civimail+s.1.2@example.com)',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -242,11 +237,11 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'return_path' => array(
+        ],
+        'return_path' => [
           'name' => 'return_path',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Return Path') ,
+          'title' => ts('Return Path'),
           'description' => 'contents of the Return-Path header',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -254,11 +249,11 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'protocol' => array(
+        ],
+        'protocol' => [
           'name' => 'protocol',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Protocol') ,
+          'title' => ts('Protocol'),
           'description' => 'name of the protocol to use for polling (like IMAP, POP3 or Maildir)',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -266,18 +261,18 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ) ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'optionGroupName' => 'mail_protocol',
             'optionEditPath' => 'civicrm/admin/options/mail_protocol',
-          )
-        ) ,
-        'server' => array(
+          ]
+        ],
+        'server' => [
           'name' => 'server',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Mail Server') ,
+          'title' => ts('Mail Server'),
           'description' => 'server to use when polling',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -285,21 +280,21 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'port' => array(
+        ],
+        'port' => [
           'name' => 'port',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Mail Port') ,
+          'title' => ts('Mail Port'),
           'description' => 'port to use when polling',
           'table_name' => 'civicrm_mail_settings',
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'username' => array(
+        ],
+        'username' => [
           'name' => 'username',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Mail Account Username') ,
+          'title' => ts('Mail Account Username'),
           'description' => 'username to use when polling',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -307,11 +302,11 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'password' => array(
+        ],
+        'password' => [
           'name' => 'password',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Mail Account Password') ,
+          'title' => ts('Mail Account Password'),
           'description' => 'password to use when polling',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -319,21 +314,21 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'is_ssl' => array(
+        ],
+        'is_ssl' => [
           'name' => 'is_ssl',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Mail Account Uses SSL') ,
+          'title' => ts('Mail Account Uses SSL'),
           'description' => 'whether to use SSL or not',
           'table_name' => 'civicrm_mail_settings',
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'source' => array(
+        ],
+        'source' => [
           'name' => 'source',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Mail Folder') ,
+          'title' => ts('Mail Folder'),
           'description' => 'folder to poll from when using IMAP, path to poll from when using Maildir, etc.',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -341,11 +336,11 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-        ) ,
-        'activity_status' => array(
+        ],
+        'activity_status' => [
           'name' => 'activity_status',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Activity Status') ,
+          'title' => ts('Activity Status'),
           'description' => 'Name of status to use when creating email to activity.',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -353,48 +348,52 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
           'entity' => 'MailSettings',
           'bao' => 'CRM_Core_BAO_MailSettings',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ) ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'optionGroupName' => 'activity_status',
             'keyColumn' => 'name',
             'optionEditPath' => 'civicrm/admin/options/activity_status',
-          )
-        ) ,
-      );
+          ]
+        ],
+      ];
       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
     }
     return Civi::$statics[__CLASS__]['fields'];
   }
+
   /**
    * Return a mapping from field-name to the corresponding key (as used in fields()).
    *
    * @return array
    *   Array(string $name => string $uniqueName).
    */
-  static function &fieldKeys() {
+  public static function &fieldKeys() {
     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
     }
     return Civi::$statics[__CLASS__]['fieldKeys'];
   }
+
   /**
    * Returns the names of this table
    *
    * @return string
    */
-  static function getTableName() {
+  public static function getTableName() {
     return self::$_tableName;
   }
+
   /**
    * Returns if this table needs to be logged
    *
-   * @return boolean
+   * @return bool
    */
-  function getLog() {
+  public function getLog() {
     return self::$_log;
   }
+
   /**
    * Returns the list of fields that can be imported
    *
@@ -402,10 +401,11 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mail_settings', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mail_settings', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -413,15 +413,21 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mail_settings', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mail_settings', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of indices
+   *
+   * @param bool $localize
+   *
+   * @return array
    */
   public static function indices($localize = TRUE) {
-    $indices = array();
+    $indices = [];
     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
   }
+
 }