Reformat DAO files to pass linting and use short array syntax
[civicrm-core.git] / CRM / PCP / DAO / PCPBlock.php
index f3a4f7a7c24ea96ffd07a2154a1e9dc0fe40fc57..b68880302e84638d396f561bb0fef7f3568b1193 100644 (file)
@@ -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
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  * (GenCodeChecksum:5e7c52122eb7d5b428bb717c7c634327)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_PCP_DAO_PCPBlock constructor.
+ * Database access object for the PCPBlock entity.
  */
 class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_pcp_block';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = true;
+  static $_log = TRUE;
+
   /**
    * PCP block Id
    *
    * @var int unsigned
    */
   public $id;
+
   /**
-   *
    * @var string
    */
   public $entity_table;
+
   /**
    * FK to civicrm_contribution_page.id OR civicrm_event.id
    *
    * @var int unsigned
    */
   public $entity_id;
+
   /**
    * The type of entity that this pcp targets
    *
    * @var string
    */
   public $target_entity_type;
+
   /**
    * The entity that this pcp targets
    *
    * @var int unsigned
    */
   public $target_entity_id;
+
   /**
    * FK to civicrm_uf_group.id. Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?
    *
    * @var int unsigned
    */
   public $supporter_profile_id;
+
   /**
    * FK to civicrm_option_group with name = PCP owner notifications
    *
    * @var int unsigned
    */
   public $owner_notify_id;
+
   /**
    * Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?
    *
    * @var boolean
    */
   public $is_approval_needed;
+
   /**
    * Does Personal Campaign Page allow using tell a friend?
    *
    * @var boolean
    */
   public $is_tellfriend_enabled;
+
   /**
    * Maximum recipient fields allowed in tell a friend
    *
    * @var int unsigned
    */
   public $tellfriend_limit;
+
   /**
    * Link text for PCP.
    *
    * @var string
    */
   public $link_text;
+
   /**
    * Is Personal Campaign Page Block enabled/active?
    *
    * @var boolean
    */
   public $is_active;
+
   /**
    * If set, notification is automatically emailed to this email-address on create/update Personal Campaign Page
    *
    * @var string
    */
   public $notify_email;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_pcp_block';
     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() , 'supporter_profile_id', 'civicrm_uf_group', 'id');
-      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
-      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'target_entity_id', NULL, 'id', 'target_entity_type');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'supporter_profile_id', 'civicrm_uf_group', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'target_entity_id', NULL, 'id', 'target_entity_type');
       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('PCP Block ID') ,
+          'title' => ts('PCP Block ID'),
           'description' => 'PCP block Id',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'entity_table' => array(
+        ],
+        'entity_table' => [
           'name' => 'entity_table',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Entity Table') ,
+          'title' => ts('Entity Table'),
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'entity_id' => array(
+        ],
+        'entity_id' => [
           'name' => 'entity_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Entity') ,
+          'title' => ts('Entity'),
           'description' => 'FK to civicrm_contribution_page.id OR civicrm_event.id',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'target_entity_type' => array(
+        ],
+        'target_entity_type' => [
           'name' => 'target_entity_type',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Target Entity') ,
+          'title' => ts('Target Entity'),
           'description' => 'The type of entity that this pcp targets',
-          'required' => true,
+          'required' => TRUE,
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'default' => 'contribute',
@@ -204,22 +196,22 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'target_entity_id' => array(
+        ],
+        'target_entity_id' => [
           'name' => 'target_entity_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Target Entity ID') ,
+          'title' => ts('Target Entity ID'),
           'description' => 'The entity that this pcp targets',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'supporter_profile_id' => array(
+        ],
+        'supporter_profile_id' => [
           'name' => 'supporter_profile_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Supporter Profile') ,
+          'title' => ts('Supporter Profile'),
           'description' => 'FK to civicrm_uf_group.id. Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?',
           'default' => 'NULL',
           'table_name' => 'civicrm_pcp_block',
@@ -227,61 +219,61 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
           'FKClassName' => 'CRM_Core_DAO_UFGroup',
-        ,
-        'owner_notify_id' => array(
+        ],
+        'owner_notify_id' => [
           'name' => 'owner_notify_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Owner Notification') ,
+          'title' => ts('Owner Notification'),
           'description' => 'FK to civicrm_option_group with name = PCP owner notifications',
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Radio',
-          ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'optionGroupName' => 'pcp_owner_notify',
             'optionEditPath' => 'civicrm/admin/options/pcp_owner_notify',
-          )
-        ,
-        'is_approval_needed' => array(
+          ]
+        ],
+        'is_approval_needed' => [
           'name' => 'is_approval_needed',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Approval Required?') ,
+          'title' => ts('Approval Required?'),
           'description' => 'Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?',
           'default' => 'NULL',
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'is_tellfriend_enabled' => array(
+        ],
+        'is_tellfriend_enabled' => [
           'name' => 'is_tellfriend_enabled',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Tell a Friend Enabled?') ,
+          'title' => ts('Tell a Friend Enabled?'),
           'description' => 'Does Personal Campaign Page allow using tell a friend?',
           'default' => 'NULL',
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'tellfriend_limit' => array(
+        ],
+        'tellfriend_limit' => [
           'name' => 'tellfriend_limit',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Tell A Friend Limit') ,
+          'title' => ts('Tell A Friend Limit'),
           'description' => 'Maximum recipient fields allowed in tell a friend',
           'default' => 'NULL',
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'link_text' => array(
+        ],
+        'link_text' => [
           'name' => 'link_text',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Link Text') ,
+          'title' => ts('Link Text'),
           'description' => 'Link text for PCP.',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -290,22 +282,22 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 1,
-        ,
-        'is_active' => array(
+        ],
+        'is_active' => [
           'name' => 'is_active',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Enabled?') ,
+          'title' => ts('Enabled?'),
           'description' => 'Is Personal Campaign Page Block enabled/active?',
           'default' => '1',
           'table_name' => 'civicrm_pcp_block',
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-        'notify_email' => array(
+        ],
+        'notify_email' => [
           'name' => 'notify_email',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Notification Email') ,
+          'title' => ts('Notification Email'),
           'description' => 'If set, notification is automatically emailed to this email-address on create/update Personal Campaign Page',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -314,40 +306,44 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
           'entity' => 'PCPBlock',
           'bao' => 'CRM_PCP_BAO_PCPBlock',
           'localizable' => 0,
-        ,
-      );
+        ],
+      ];
       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 CRM_Core_DAO::getLocaleTableName(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
    *
@@ -355,10 +351,11 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'pcp_block', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'pcp_block', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -366,15 +363,21 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'pcp_block', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'pcp_block', $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;
   }
+
 }