<?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
*
* Generated from xml/schema/CRM/Report/ReportInstance.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:e28abdd2a3696c4a6072dfbfd4f54d68)
+ * (GenCodeChecksum:09ffdd1693f38f5790d4c9c00d3c5d2f)
*/
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
/**
- * CRM_Report_DAO_ReportInstance constructor.
+ * Database access object for the ReportInstance entity.
*/
class CRM_Report_DAO_ReportInstance extends CRM_Core_DAO {
+
/**
* Static instance to hold the table name.
*
* @var string
*/
static $_tableName = 'civicrm_report_instance';
+
/**
* Should CiviCRM log any modifications to this table in the civicrm_log table.
*
- * @var boolean
+ * @var bool
*/
- static $_log = false;
+ static $_log = FALSE;
+
/**
* Report Instance ID
*
* @var int unsigned
*/
public $id;
+
/**
* Which Domain is this instance for
*
* @var int unsigned
*/
public $domain_id;
+
/**
* Report Instance Title.
*
* @var string
*/
public $title;
+
/**
* FK to civicrm_option_value for the report template
*
* @var string
*/
public $report_id;
+
/**
* when combined with report_id/template uniquely identifies the instance
*
* @var string
*/
public $name;
+
/**
* arguments that are passed in the url when invoking the instance
*
* @var string
*/
public $args;
+
/**
* Report Instance description.
*
* @var string
*/
public $description;
+
/**
* permission required to be able to run this instance
*
* @var string
*/
public $permission;
+
/**
* role required to be able to run this instance
*
* @var string
*/
public $grouprole;
+
/**
* Submitted form values for this report
*
* @var text
*/
public $form_values;
+
/**
* Is this entry active?
*
* @var boolean
*/
public $is_active;
+
/**
* FK to contact table.
*
* @var int unsigned
*/
public $created_id;
+
/**
* FK to contact table.
*
* @var int unsigned
*/
public $owner_id;
+
/**
* Subject of email
*
* @var string
*/
public $email_subject;
+
/**
* comma-separated list of email addresses to send the report to
*
* @var text
*/
public $email_to;
+
/**
* comma-separated list of email addresses to send the report to
*
* @var text
*/
public $email_cc;
+
/**
* comma-separated list of email addresses to send the report to
*
* @var text
*/
public $header;
+
/**
* comma-separated list of email addresses to send the report to
*
* @var text
*/
public $footer;
+
/**
* FK to navigation ID
*
* @var int unsigned
*/
public $navigation_id;
+
/**
* FK to instance ID drilldown to
*
* @var int unsigned
*/
public $drilldown_id;
+
/**
- *
* @var boolean
*/
public $is_reserved;
+
/**
* Class constructor.
*/
- function __construct() {
+ public function __construct() {
$this->__table = 'civicrm_report_instance';
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() , 'created_id', 'civicrm_contact', 'id');
- Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'owner_id', 'civicrm_contact', 'id');
- Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'navigation_id', 'civicrm_navigation', 'id');
- Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'drilldown_id', 'civicrm_report_instance', 'id');
+ 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(), 'created_id', 'civicrm_contact', 'id');
+ Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'owner_id', 'civicrm_contact', 'id');
+ Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'navigation_id', 'civicrm_navigation', 'id');
+ Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'drilldown_id', 'civicrm_report_instance', '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('Report Instance ID') ,
+ 'title' => ts('Report Instance ID'),
'description' => 'Report Instance ID',
- 'required' => true,
+ 'required' => TRUE,
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- ) ,
- 'domain_id' => array(
+ ],
+ 'domain_id' => [
'name' => 'domain_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Report Instance Domain ID') ,
+ 'title' => ts('Report Instance Domain ID'),
'description' => 'Which Domain is this instance for',
- 'required' => true,
+ 'required' => TRUE,
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
'FKClassName' => 'CRM_Core_DAO_Domain',
- 'pseudoconstant' => array(
+ 'pseudoconstant' => [
'table' => 'civicrm_domain',
'keyColumn' => 'id',
'labelColumn' => 'name',
- )
- ) ,
- 'title' => array(
+ ]
+ ],
+ 'title' => [
'name' => 'title',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report Instance Title') ,
+ 'title' => ts('Report Instance Title'),
'description' => 'Report Instance Title.',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'report_id' => array(
+ ],
+ ],
+ 'report_id' => [
'name' => 'report_id',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report template ID') ,
+ 'title' => ts('Report template ID'),
'description' => 'FK to civicrm_option_value for the report template',
- 'required' => true,
+ 'required' => TRUE,
'maxlength' => 512,
'size' => CRM_Utils_Type::HUGE,
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Select',
- ) ,
- ) ,
- 'name' => array(
+ ],
+ ],
+ 'name' => [
'name' => 'name',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report instance Name') ,
+ 'title' => ts('Report instance Name'),
'description' => 'when combined with report_id/template uniquely identifies the instance',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'args' => array(
+ ],
+ ],
+ 'args' => [
'name' => 'args',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report Instance Arguments') ,
+ 'title' => ts('Report Instance Arguments'),
'description' => 'arguments that are passed in the url when invoking the instance',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'description' => array(
+ ],
+ ],
+ 'description' => [
'name' => 'description',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report Instance description') ,
+ 'title' => ts('Report Instance description'),
'description' => 'Report Instance description.',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'permission' => array(
+ ],
+ ],
+ 'permission' => [
'name' => 'permission',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report Instance Permissions') ,
+ 'title' => ts('Report Instance Permissions'),
'description' => 'permission required to be able to run this instance',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'grouprole' => array(
+ ],
+ ],
+ 'grouprole' => [
'name' => 'grouprole',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report Instance Assigned to Roles') ,
+ 'title' => ts('Report Instance Assigned to Roles'),
'description' => 'role required to be able to run this instance',
'maxlength' => 1024,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'form_values' => array(
+ ],
+ ],
+ 'form_values' => [
'name' => 'form_values',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Submitted Form Values') ,
+ 'title' => ts('Submitted Form Values'),
'description' => 'Submitted form values for this report',
- 'import' => true,
+ 'import' => TRUE,
'where' => 'civicrm_report_instance.form_values',
'headerPattern' => '',
'dataPattern' => '',
- 'export' => true,
+ 'export' => TRUE,
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- ) ,
- 'is_active' => array(
+ 'serialize' => self::SERIALIZE_PHP,
+ ],
+ 'is_active' => [
'name' => 'is_active',
'type' => CRM_Utils_Type::T_BOOLEAN,
- 'title' => ts('Report Instance is Active') ,
+ 'title' => ts('Report Instance is Active'),
'description' => 'Is this entry active?',
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'CheckBox',
- ) ,
- ) ,
- 'created_id' => array(
+ ],
+ ],
+ 'created_id' => [
'name' => 'created_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Report Instance Created By') ,
+ 'title' => ts('Report Instance Created By'),
'description' => 'FK to contact table.',
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
- ) ,
- 'owner_id' => array(
+ ],
+ 'owner_id' => [
'name' => 'owner_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Report Instance Owned By') ,
+ 'title' => ts('Report Instance Owned By'),
'description' => 'FK to contact table.',
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
- ) ,
- 'email_subject' => array(
+ ],
+ 'email_subject' => [
'name' => 'email_subject',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Report Instance email Subject') ,
+ 'title' => ts('Report Instance email Subject'),
'description' => 'Subject of email',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'email_to' => array(
+ ],
+ ],
+ 'email_to' => [
'name' => 'email_to',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Email Report Instance To') ,
+ 'title' => ts('Email Report Instance To'),
'description' => 'comma-separated list of email addresses to send the report to',
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'email_cc' => array(
+ ],
+ ],
+ 'email_cc' => [
'name' => 'email_cc',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('cc Email Report Instance To') ,
+ 'title' => ts('cc Email Report Instance To'),
'description' => 'comma-separated list of email addresses to send the report to',
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'header' => array(
+ ],
+ ],
+ 'header' => [
'name' => 'header',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Report Instance Header') ,
+ 'title' => ts('Report Instance Header'),
'description' => 'comma-separated list of email addresses to send the report to',
'rows' => 4,
'cols' => 60,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'TextArea',
- ) ,
- ) ,
- 'footer' => array(
+ ],
+ ],
+ 'footer' => [
'name' => 'footer',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Report Instance Footer') ,
+ 'title' => ts('Report Instance Footer'),
'description' => 'comma-separated list of email addresses to send the report to',
'rows' => 4,
'cols' => 60,
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'TextArea',
- ) ,
- ) ,
- 'navigation_id' => array(
+ ],
+ ],
+ 'navigation_id' => [
'name' => 'navigation_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Navigation ID') ,
+ 'title' => ts('Navigation ID'),
'description' => 'FK to navigation ID',
- 'import' => true,
+ 'import' => TRUE,
'where' => 'civicrm_report_instance.navigation_id',
'headerPattern' => '',
'dataPattern' => '',
- 'export' => true,
+ 'export' => TRUE,
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
'FKClassName' => 'CRM_Core_DAO_Navigation',
- ) ,
- 'drilldown_id' => array(
+ ],
+ 'drilldown_id' => [
'name' => 'drilldown_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Drilldown Report ID') ,
+ 'title' => ts('Drilldown Report ID'),
'description' => 'FK to instance ID drilldown to',
- 'import' => true,
+ 'import' => TRUE,
'where' => 'civicrm_report_instance.drilldown_id',
'headerPattern' => '',
'dataPattern' => '',
- 'export' => true,
+ 'export' => TRUE,
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
'FKClassName' => 'CRM_Report_DAO_ReportInstance',
- ) ,
- 'is_reserved' => array(
+ ],
+ 'is_reserved' => [
'name' => 'is_reserved',
'type' => CRM_Utils_Type::T_BOOLEAN,
- 'title' => ts('Instance is Reserved') ,
+ 'title' => ts('Instance is Reserved'),
'table_name' => 'civicrm_report_instance',
'entity' => 'ReportInstance',
'bao' => 'CRM_Report_BAO_ReportInstance',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'CheckBox',
- ) ,
- ) ,
- );
+ ],
+ ],
+ ];
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
*
*
* @return array
*/
- static function &import($prefix = false) {
- $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'report_instance', $prefix, array());
+ public static function &import($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'report_instance', $prefix, []);
return $r;
}
+
/**
* Returns the list of fields that can be exported
*
*
* @return array
*/
- static function &export($prefix = false) {
- $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'report_instance', $prefix, array());
+ public static function &export($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'report_instance', $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;
}
+
}
projects / civicrm-core.git / blobdiff