264 lines
8.7 KiB
PHP
264 lines
8.7 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/Contact/SavedSearch.xml
|
||
|
|
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
||
|
|
* (GenCodeChecksum:8e799b35db1b6a38deee5a757d4183c0)
|
||
|
|
*/
|
||
|
|
require_once 'CRM/Core/DAO.php';
|
||
|
|
require_once 'CRM/Utils/Type.php';
|
||
|
|
/**
|
||
|
|
* CRM_Contact_DAO_SavedSearch constructor.
|
||
|
|
*/
|
||
|
|
class CRM_Contact_DAO_SavedSearch extends CRM_Core_DAO {
|
||
|
|
/**
|
||
|
|
* Static instance to hold the table name.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
static $_tableName = 'civicrm_saved_search';
|
||
|
|
/**
|
||
|
|
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
||
|
|
*
|
||
|
|
* @var boolean
|
||
|
|
*/
|
||
|
|
static $_log = false;
|
||
|
|
/**
|
||
|
|
* Saved Search ID
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $id;
|
||
|
|
/**
|
||
|
|
* Submitted form values for this search
|
||
|
|
*
|
||
|
|
* @var text
|
||
|
|
*/
|
||
|
|
public $form_values;
|
||
|
|
/**
|
||
|
|
* Foreign key to civicrm_mapping used for saved search-builder searches.
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $mapping_id;
|
||
|
|
/**
|
||
|
|
* Foreign key to civicrm_option value table used for saved custom searches.
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $search_custom_id;
|
||
|
|
/**
|
||
|
|
* the sql where clause if a saved search acl
|
||
|
|
*
|
||
|
|
* @var text
|
||
|
|
*/
|
||
|
|
public $where_clause;
|
||
|
|
/**
|
||
|
|
* the tables to be included in a select data
|
||
|
|
*
|
||
|
|
* @var text
|
||
|
|
*/
|
||
|
|
public $select_tables;
|
||
|
|
/**
|
||
|
|
* the tables to be included in the count statement
|
||
|
|
*
|
||
|
|
* @var text
|
||
|
|
*/
|
||
|
|
public $where_tables;
|
||
|
|
/**
|
||
|
|
* Class constructor.
|
||
|
|
*/
|
||
|
|
function __construct() {
|
||
|
|
$this->__table = 'civicrm_saved_search';
|
||
|
|
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() , 'mapping_id', 'civicrm_mapping', '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('Saved Search ID') ,
|
||
|
|
'description' => 'Saved Search ID',
|
||
|
|
'required' => true,
|
||
|
|
'table_name' => 'civicrm_saved_search',
|
||
|
|
'entity' => 'SavedSearch',
|
||
|
|
'bao' => 'CRM_Contact_BAO_SavedSearch',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'form_values' => array(
|
||
|
|
'name' => 'form_values',
|
||
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
||
|
|
'title' => ts('Submitted Form Values') ,
|
||
|
|
'description' => 'Submitted form values for this search',
|
||
|
|
'import' => true,
|
||
|
|
'where' => 'civicrm_saved_search.form_values',
|
||
|
|
'headerPattern' => '',
|
||
|
|
'dataPattern' => '',
|
||
|
|
'export' => true,
|
||
|
|
'table_name' => 'civicrm_saved_search',
|
||
|
|
'entity' => 'SavedSearch',
|
||
|
|
'bao' => 'CRM_Contact_BAO_SavedSearch',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'mapping_id' => array(
|
||
|
|
'name' => 'mapping_id',
|
||
|
|
'type' => CRM_Utils_Type::T_INT,
|
||
|
|
'title' => ts('Mapping ID') ,
|
||
|
|
'description' => 'Foreign key to civicrm_mapping used for saved search-builder searches.',
|
||
|
|
'table_name' => 'civicrm_saved_search',
|
||
|
|
'entity' => 'SavedSearch',
|
||
|
|
'bao' => 'CRM_Contact_BAO_SavedSearch',
|
||
|
|
'localizable' => 0,
|
||
|
|
'FKClassName' => 'CRM_Core_DAO_Mapping',
|
||
|
|
) ,
|
||
|
|
'search_custom_id' => array(
|
||
|
|
'name' => 'search_custom_id',
|
||
|
|
'type' => CRM_Utils_Type::T_INT,
|
||
|
|
'title' => ts('Option Value ID') ,
|
||
|
|
'description' => 'Foreign key to civicrm_option value table used for saved custom searches.',
|
||
|
|
'table_name' => 'civicrm_saved_search',
|
||
|
|
'entity' => 'SavedSearch',
|
||
|
|
'bao' => 'CRM_Contact_BAO_SavedSearch',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'where_clause' => array(
|
||
|
|
'name' => 'where_clause',
|
||
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
||
|
|
'title' => ts('Where Clause') ,
|
||
|
|
'description' => 'the sql where clause if a saved search acl',
|
||
|
|
'table_name' => 'civicrm_saved_search',
|
||
|
|
'entity' => 'SavedSearch',
|
||
|
|
'bao' => 'CRM_Contact_BAO_SavedSearch',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'select_tables' => array(
|
||
|
|
'name' => 'select_tables',
|
||
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
||
|
|
'title' => ts('Select Tables') ,
|
||
|
|
'description' => 'the tables to be included in a select data',
|
||
|
|
'table_name' => 'civicrm_saved_search',
|
||
|
|
'entity' => 'SavedSearch',
|
||
|
|
'bao' => 'CRM_Contact_BAO_SavedSearch',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'where_tables' => array(
|
||
|
|
'name' => 'where_tables',
|
||
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
||
|
|
'title' => ts('Where Tables') ,
|
||
|
|
'description' => 'the tables to be included in the count statement',
|
||
|
|
'table_name' => 'civicrm_saved_search',
|
||
|
|
'entity' => 'SavedSearch',
|
||
|
|
'bao' => 'CRM_Contact_BAO_SavedSearch',
|
||
|
|
'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 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__, 'saved_search', $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__, 'saved_search', $prefix, array());
|
||
|
|
return $r;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Returns the list of indices
|
||
|
|
*/
|
||
|
|
public static function indices($localize = TRUE) {
|
||
|
|
$indices = array();
|
||
|
|
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
|
||
|
|
}
|
||
|
|
}
|