drupal-civicrm/sites/all/modules/civicrm/CRM/Campaign/DAO/Survey.php
2018-01-14 13:10:16 +00:00

530 lines
17 KiB
PHP

<?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/Campaign/Survey.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
* (GenCodeChecksum:55aa9d31d08f8b5353d42dde1278b7f2)
*/
require_once 'CRM/Core/DAO.php';
require_once 'CRM/Utils/Type.php';
/**
* CRM_Campaign_DAO_Survey constructor.
*/
class CRM_Campaign_DAO_Survey extends CRM_Core_DAO {
/**
* Static instance to hold the table name.
*
* @var string
*/
static $_tableName = 'civicrm_survey';
/**
* Should CiviCRM log any modifications to this table in the civicrm_log table.
*
* @var boolean
*/
static $_log = false;
/**
* Survey id.
*
* @var int unsigned
*/
public $id;
/**
* Title of the Survey.
*
* @var string
*/
public $title;
/**
* Foreign key to the Campaign.
*
* @var int unsigned
*/
public $campaign_id;
/**
* Implicit FK to civicrm_option_value where option_group = activity_type
*
* @var int unsigned
*/
public $activity_type_id;
/**
* Recontact intervals for each status.
*
* @var text
*/
public $recontact_interval;
/**
* Script instructions for volunteers to use for the survey.
*
* @var text
*/
public $instructions;
/**
* Number of days for recurrence of release.
*
* @var int unsigned
*/
public $release_frequency;
/**
* Maximum number of contacts to allow for survey.
*
* @var int unsigned
*/
public $max_number_of_contacts;
/**
* Default number of contacts to allow for survey.
*
* @var int unsigned
*/
public $default_number_of_contacts;
/**
* Is this survey enabled or disabled/cancelled?
*
* @var boolean
*/
public $is_active;
/**
* Is this default survey?
*
* @var boolean
*/
public $is_default;
/**
* FK to civicrm_contact, who created this Survey.
*
* @var int unsigned
*/
public $created_id;
/**
* Date and time that Survey was created.
*
* @var datetime
*/
public $created_date;
/**
* FK to civicrm_contact, who recently edited this Survey.
*
* @var int unsigned
*/
public $last_modified_id;
/**
* Date and time that Survey was edited last time.
*
* @var datetime
*/
public $last_modified_date;
/**
* Used to store option group id.
*
* @var int unsigned
*/
public $result_id;
/**
* Bypass the email verification.
*
* @var boolean
*/
public $bypass_confirm;
/**
* Title for Thank-you page (header title tag, and display at the top of the page).
*
* @var string
*/
public $thankyou_title;
/**
* text and html allowed. displayed above result on success page
*
* @var text
*/
public $thankyou_text;
/**
* Can people share the petition through social media?
*
* @var boolean
*/
public $is_share;
/**
* Class constructor.
*/
function __construct() {
$this->__table = 'civicrm_survey';
parent::__construct();
}
/**
* Returns foreign keys and entity references.
*
* @return array
* [CRM_Core_Reference_Interface]
*/
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() , 'campaign_id', 'civicrm_campaign', '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() , 'last_modified_id', 'civicrm_contact', '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() {
if (!isset(Civi::$statics[__CLASS__]['fields'])) {
Civi::$statics[__CLASS__]['fields'] = array(
'id' => array(
'name' => 'id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Survey ID') ,
'description' => 'Survey id.',
'required' => true,
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'title' => array(
'name' => 'title',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Survey Title') ,
'description' => 'Title of the Survey.',
'required' => true,
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'import' => true,
'where' => 'civicrm_survey.title',
'headerPattern' => '',
'dataPattern' => '',
'export' => true,
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 1,
) ,
'campaign_id' => array(
'name' => 'campaign_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Survey Campaign ID') ,
'description' => 'Foreign key to the Campaign.',
'default' => 'NULL',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
'FKClassName' => 'CRM_Campaign_DAO_Campaign',
'pseudoconstant' => array(
'table' => 'civicrm_campaign',
'keyColumn' => 'id',
'labelColumn' => 'title',
)
) ,
'activity_type_id' => array(
'name' => 'activity_type_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Activity Type') ,
'description' => 'Implicit FK to civicrm_option_value where option_group = activity_type',
'import' => true,
'where' => 'civicrm_survey.activity_type_id',
'headerPattern' => '',
'dataPattern' => '',
'export' => true,
'default' => 'NULL',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
'html' => array(
'type' => 'Select',
) ,
'pseudoconstant' => array(
'optionGroupName' => 'activity_type',
'optionEditPath' => 'civicrm/admin/options/activity_type',
)
) ,
'recontact_interval' => array(
'name' => 'recontact_interval',
'type' => CRM_Utils_Type::T_TEXT,
'title' => ts('Follow up Interval') ,
'description' => 'Recontact intervals for each status.',
'rows' => 20,
'cols' => 80,
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
'html' => array(
'type' => 'TextArea',
) ,
) ,
'instructions' => array(
'name' => 'instructions',
'type' => CRM_Utils_Type::T_TEXT,
'title' => ts('Instructions') ,
'description' => 'Script instructions for volunteers to use for the survey.',
'rows' => 20,
'cols' => 80,
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 1,
'html' => array(
'type' => 'TextArea',
) ,
) ,
'release_frequency' => array(
'name' => 'release_frequency',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Survey Hold Duration') ,
'description' => 'Number of days for recurrence of release.',
'default' => 'NULL',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'max_number_of_contacts' => array(
'name' => 'max_number_of_contacts',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Maximum number of contacts') ,
'description' => 'Maximum number of contacts to allow for survey.',
'default' => 'NULL',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'default_number_of_contacts' => array(
'name' => 'default_number_of_contacts',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Default number of contacts') ,
'description' => 'Default number of contacts to allow for survey.',
'default' => 'NULL',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'is_active' => array(
'name' => 'is_active',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Survey Is Active') ,
'description' => 'Is this survey enabled or disabled/cancelled?',
'default' => '1',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'is_default' => array(
'name' => 'is_default',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Is Default Survey') ,
'description' => 'Is this default survey?',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'created_id' => array(
'name' => 'created_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Survey Created By') ,
'description' => 'FK to civicrm_contact, who created this Survey.',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
) ,
'created_date' => array(
'name' => 'created_date',
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
'title' => ts('Campaign Created Date') ,
'description' => 'Date and time that Survey was created.',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'last_modified_id' => array(
'name' => 'last_modified_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Survey Modified') ,
'description' => 'FK to civicrm_contact, who recently edited this Survey.',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
) ,
'last_modified_date' => array(
'name' => 'last_modified_date',
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
'title' => ts('Survey Modified On') ,
'description' => 'Date and time that Survey was edited last time.',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'result_id' => array(
'name' => 'result_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Survey Result') ,
'description' => 'Used to store option group id.',
'default' => 'NULL',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'bypass_confirm' => array(
'name' => 'bypass_confirm',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('No Email Verification') ,
'description' => 'Bypass the email verification.',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 0,
) ,
'thankyou_title' => array(
'name' => 'thankyou_title',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Thank-you Title') ,
'description' => 'Title for Thank-you page (header title tag, and display at the top of the page).',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 1,
) ,
'thankyou_text' => array(
'name' => 'thankyou_text',
'type' => CRM_Utils_Type::T_TEXT,
'title' => ts('Thank-you Text') ,
'description' => 'text and html allowed. displayed above result on success page',
'rows' => 8,
'cols' => 60,
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'localizable' => 1,
'html' => array(
'type' => 'TextArea',
) ,
) ,
'is_share' => array(
'name' => 'is_share',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Is shared through social media') ,
'description' => 'Can people share the petition through social media?',
'default' => '1',
'table_name' => 'civicrm_survey',
'entity' => 'Survey',
'bao' => 'CRM_Campaign_BAO_Survey',
'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() {
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() {
return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
}
/**
* Returns if this table needs to be logged
*
* @return boolean
*/
function getLog() {
return self::$_log;
}
/**
* Returns the list of fields that can be imported
*
* @param bool $prefix
*
* @return array
*/
static function &import($prefix = false) {
$r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'survey', $prefix, array());
return $r;
}
/**
* Returns the list of fields that can be exported
*
* @param bool $prefix
*
* @return array
*/
static function &export($prefix = false) {
$r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'survey', $prefix, array());
return $r;
}
/**
* Returns the list of indices
*/
public static function indices($localize = TRUE) {
$indices = array(
'UI_activity_type_id' => array(
'name' => 'UI_activity_type_id',
'field' => array(
0 => 'activity_type_id',
) ,
'localizable' => false,
'sig' => 'civicrm_survey::0::activity_type_id',
) ,
);
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
}
}