Merge pull request #8916 from cividesk/CRM-19256-4.7
[civicrm-core.git] / CRM / Core / DAO / Worldregion.php
CommitLineData
e501603b
TO
1<?php
2/*
3+--------------------------------------------------------------------+
4| CiviCRM version 4.7 |
5+--------------------------------------------------------------------+
0f03f337 6| Copyright CiviCRM LLC (c) 2004-2017 |
e501603b
TO
7+--------------------------------------------------------------------+
8| This file is a part of CiviCRM. |
9| |
10| CiviCRM is free software; you can copy, modify, and distribute it |
11| under the terms of the GNU Affero General Public License |
12| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13| |
14| CiviCRM is distributed in the hope that it will be useful, but |
15| WITHOUT ANY WARRANTY; without even the implied warranty of |
16| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17| See the GNU Affero General Public License for more details. |
18| |
19| You should have received a copy of the GNU Affero General Public |
20| License and the CiviCRM Licensing Exception along |
21| with this program; if not, contact CiviCRM LLC |
22| at info[AT]civicrm[DOT]org. If you have questions about the |
23| GNU Affero General Public License or the licensing of CiviCRM, |
24| see the CiviCRM license FAQ at http://civicrm.org/licensing |
25+--------------------------------------------------------------------+
26*/
27/**
28 * @package CRM
0f03f337 29 * @copyright CiviCRM LLC (c) 2004-2017
e501603b
TO
30 *
31 * Generated from xml/schema/CRM/Core/Worldregion.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
437fafcf 33 * (GenCodeChecksum:710a568363468092ddc0fc7d1b14abd1)
e501603b
TO
34 */
35require_once 'CRM/Core/DAO.php';
36require_once 'CRM/Utils/Type.php';
f41f0342 37/**
38 * CRM_Core_DAO_Worldregion constructor.
39 */
e501603b
TO
40class CRM_Core_DAO_Worldregion extends CRM_Core_DAO {
41 /**
f41f0342 42 * Static instance to hold the table name.
e501603b
TO
43 *
44 * @var string
45 */
46 static $_tableName = 'civicrm_worldregion';
e501603b 47 /**
f41f0342 48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
e501603b
TO
49 *
50 * @var boolean
51 */
52 static $_log = false;
53 /**
54 * Country Id
55 *
56 * @var int unsigned
57 */
58 public $id;
59 /**
60 * Region name to be associated with countries
61 *
62 * @var string
63 */
64 public $name;
65 /**
f41f0342 66 * Class constructor.
e501603b
TO
67 */
68 function __construct() {
69 $this->__table = 'civicrm_worldregion';
70 parent::__construct();
71 }
72 /**
73 * Returns all the column names of this table
74 *
75 * @return array
76 */
77 static function &fields() {
346aaaba
TO
78 if (!isset(Civi::$statics[__CLASS__]['fields'])) {
79 Civi::$statics[__CLASS__]['fields'] = array(
e501603b
TO
80 'id' => array(
81 'name' => 'id',
82 'type' => CRM_Utils_Type::T_INT,
83 'title' => ts('World Region ID') ,
84 'description' => 'Country Id',
85 'required' => true,
86 ) ,
87 'world_region' => array(
88 'name' => 'name',
89 'type' => CRM_Utils_Type::T_STRING,
90 'title' => ts('World Region') ,
91 'description' => 'Region name to be associated with countries',
92 'maxlength' => 128,
93 'size' => CRM_Utils_Type::HUGE,
94 'export' => true,
95 'where' => 'civicrm_worldregion.name',
96 'headerPattern' => '',
97 'dataPattern' => '',
98 ) ,
99 );
346aaaba 100 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
e501603b 101 }
346aaaba 102 return Civi::$statics[__CLASS__]['fields'];
e501603b
TO
103 }
104 /**
bd8e0b14 105 * Return a mapping from field-name to the corresponding key (as used in fields()).
e501603b
TO
106 *
107 * @return array
bd8e0b14 108 * Array(string $name => string $uniqueName).
e501603b
TO
109 */
110 static function &fieldKeys() {
bd8e0b14
TO
111 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
112 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
e501603b 113 }
bd8e0b14 114 return Civi::$statics[__CLASS__]['fieldKeys'];
e501603b
TO
115 }
116 /**
117 * Returns the names of this table
118 *
119 * @return string
120 */
121 static function getTableName() {
122 return self::$_tableName;
123 }
124 /**
125 * Returns if this table needs to be logged
126 *
127 * @return boolean
128 */
129 function getLog() {
130 return self::$_log;
131 }
132 /**
133 * Returns the list of fields that can be imported
134 *
135 * @param bool $prefix
136 *
137 * @return array
138 */
139 static function &import($prefix = false) {
60808919
TO
140 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'worldregion', $prefix, array());
141 return $r;
e501603b
TO
142 }
143 /**
144 * Returns the list of fields that can be exported
145 *
146 * @param bool $prefix
147 *
148 * @return array
149 */
150 static function &export($prefix = false) {
60808919
TO
151 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'worldregion', $prefix, array());
152 return $r;
e501603b
TO
153 }
154}