549c50533e07de346ef871cca0cb72200e0ad2b1
2 ini_set('include_path', '.' . PATH_SEPARATOR
. '..' . DIRECTORY_SEPARATOR
. 'packages' . PATH_SEPARATOR
. '..');
3 // make sure the memory_limit is at least 512 MB
4 $memLimitString = trim(ini_get('memory_limit'));
5 $memLimitUnit = strtolower(substr($memLimitString, -1));
6 $memLimit = (int) $memLimitString;
7 switch ($memLimitUnit) {
8 case 'g': $memLimit *= 1024;
9 case 'm': $memLimit *= 1024;
10 case 'k': $memLimit *= 1024;
13 if ($memLimit >= 0 and $memLimit < 536870912) {
14 ini_set('memory_limit', '512M');
16 date_default_timezone_set('UTC'); // avoid php warnings if timezone is not set - CRM-10844
18 define('CIVICRM_UF', 'Drupal');
20 require_once 'CRM/Core/ClassLoader.php';
21 CRM_Core_ClassLoader
::singleton()->register();
23 $genCode = new CRM_GenCode_Main('../CRM/Core/DAO/', '../sql/', '../', '../templates/');
27 empty($argv[1]) ?
'schema/Schema.xml' : $argv[1]
30 class CRM_GenCode_Util_File
{
31 static function createDir($dir, $perm = 0755) {
33 mkdir($dir, $perm, TRUE);
37 static function removeDir($dir) {
38 foreach (glob("$dir/*") as $tempFile) {
44 static function createTempDir($prefix) {
45 if (isset($_SERVER['TMPDIR'])) {
46 $tempDir = $_SERVER['TMPDIR'];
52 $newTempDir = $tempDir . '/' . $prefix . rand(1, 10000);
54 if (file_exists($newTempDir)) {
55 self
::removeDir($newTempDir);
57 self
::createDir($newTempDir);
63 class CRM_GenCode_Main
{
75 function __construct($CoreDAOCodePath, $sqlCodePath, $phpCodePath, $tplCodePath) {
76 $this->CoreDAOCodePath
= $CoreDAOCodePath;
77 $this->sqlCodePath
= $sqlCodePath;
78 $this->phpCodePath
= $phpCodePath;
79 $this->tplCodePath
= $tplCodePath;
81 require_once 'Smarty/Smarty.class.php';
82 $this->smarty
= new Smarty();
83 $this->smarty
->template_dir
= './templates';
84 $this->smarty
->plugins_dir
= array('../packages/Smarty/plugins', '../CRM/Core/Smarty/plugins');
85 $this->compileDir
= CRM_GenCode_Util_File
::createTempDir('templates_c_');
86 $this->smarty
->compile_dir
= $this->compileDir
;
87 $this->smarty
->clear_all_cache();
89 // CRM-5308 / CRM-3507 - we need {localize} to work in the templates
90 require_once 'CRM/Core/Smarty/plugins/block.localize.php';
91 $this->smarty
->register_block('localize', 'smarty_block_localize');
93 require_once 'PHP/Beautifier.php';
95 $this->beautifier
= new PHP_Beautifier();
96 $this->beautifier
->addFilter('ArrayNested');
97 // add one or more filters
98 $this->beautifier
->addFilter('Pear');
99 // add one or more filters
100 $this->beautifier
->addFilter('NewLines', array('after' => 'class, public, require, comment'));
101 $this->beautifier
->setIndentChar(' ');
102 $this->beautifier
->setIndentNumber(2);
103 $this->beautifier
->setNewLine("\n");
105 CRM_GenCode_Util_File
::createDir($this->sqlCodePath
);
108 function __destruct() {
109 CRM_GenCode_Util_File
::removeDir($this->compileDir
);
113 * Automatically generate a variety of files
115 * @param $argVersion string, optional
116 * @param $argCms string, optional; "drupal" or "joomla"
117 * @param $file, the path to the XML schema file
119 function main($argVersion, $argCms, $file) {
120 $versionFile = "version.xml";
121 $versionXML = &$this->parseInput($versionFile);
122 $db_version = $versionXML->version_no
;
123 $this->buildVersion
= preg_replace('/^(\d{1,2}\.\d{1,2})\.(\d{1,2}|\w{4,7})$/i', '$1', $db_version);
124 if (isset($argVersion)) {
125 // change the version to that explicitly passed, if any
126 $db_version = $argVersion;
128 echo "\ncivicrm_domain.version := $db_version\n\n";
129 if ($this->buildVersion
< 1.1) {
130 echo "The Database is not compatible for this version";
134 if (substr(phpversion(), 0, 1) != 5) {
135 echo phpversion() . ', ' . substr(phpversion(), 0, 1) . "\n";
137 CiviCRM requires a PHP Version >= 5
138 Please upgrade your php / webserver configuration
139 Alternatively you can get a version of CiviCRM that matches your PHP version
144 $this->generateTemplateVersion($db_version);
146 $this->setupCms($argCms, $db_version);
148 echo "Parsing input file $file\n";
149 $dbXML = $this->parseInput($file);
150 // print_r( $dbXML );
152 echo "Extracting database information\n";
153 $database = &$this->getDatabase($dbXML);
154 // print_r( $database );
156 $this->classNames
= array();
158 echo "Extracting table information\n";
159 $tables = &$this->getTables($dbXML, $database);
161 $this->resolveForeignKeys($tables, $this->classNames
);
162 $tables = $this->orderTables($tables);
164 // add archive tables here
165 $archiveTables = array( );
166 foreach ($tables as $name => $table ) {
167 if ( $table['archive'] == 'true' ) {
168 $name = 'archive_' . $table['name'];
169 $table['name'] = $name;
170 $table['archive'] = 'false';
171 if ( isset($table['foreignKey']) ) {
172 foreach ($table['foreignKey'] as $fkName => $fkValue) {
173 if ($tables[$fkValue['table']]['archive'] == 'true') {
174 $table['foreignKey'][$fkName]['table'] = 'archive_' . $table['foreignKey'][$fkName]['table'];
175 $table['foreignKey'][$fkName]['uniqName'] =
176 str_replace( 'FK_', 'FK_archive_', $table['foreignKey'][$fkName]['uniqName'] );
179 $archiveTables[$name] = $table;
184 $this->generateListAll($tables);
185 $this->generateCiviTestTruncate($tables);
186 $this->generateCreateSql($database, $tables, 'civicrm.mysql');
187 $this->generateDropSql($tables, 'civicrm_drop.mysql');
189 // also create the archive tables
190 // $this->generateCreateSql($database, $archiveTables, 'civicrm_archive.mysql' );
191 // $this->generateDropSql($archiveTables, 'civicrm_archive_drop.mysql');
193 $this->generateNavigation();
194 $this->generateLocalDataSql($db_version, $this->findLocales());
195 $this->generateSample();
196 $this->generateInstallLangs();
197 $this->generateDAOs($tables);
198 $this->generateSchemaStructure($tables);
201 function generateListAll($tables) {
202 $this->smarty
->clear_all_assign();
203 $this->smarty
->assign('tables', $tables);
204 file_put_contents($this->CoreDAOCodePath
. "AllCoreTables.php", $this->smarty
->fetch('listAll.tpl'));
207 function generateCiviTestTruncate($tables) {
208 echo "Generating tests truncate file\n";
210 $truncate = '<?xml version="1.0" encoding="UTF-8" ?>
211 <!-- Truncate all tables that will be used in the tests -->
213 $tbls = array_keys($tables);
214 foreach ($tbls as $d => $t) {
215 $truncate = $truncate . "\n <$t />\n";
218 $truncate = $truncate . "</dataset>\n";
219 file_put_contents($this->sqlCodePath
. "../tests/phpunit/CiviTest/truncate.xml", $truncate);
223 function generateCreateSql($database, $tables, $fileName = 'civicrm.mysql') {
224 echo "Generating sql file\n";
225 $this->reset_smarty_assignments();
226 $this->smarty
->assign_by_ref('database', $database);
227 $this->smarty
->assign_by_ref('tables', $tables);
228 $dropOrder = array_reverse(array_keys($tables));
229 $this->smarty
->assign_by_ref('dropOrder', $dropOrder);
230 $this->smarty
->assign('mysql', 'modern');
231 file_put_contents($this->sqlCodePath
. $fileName, $this->smarty
->fetch('schema.tpl'));
234 function generateDropSql($tables, $fileName = 'civicrm_drop.mysql') {
235 echo "Generating sql drop tables file\n";
236 $dropOrder = array_reverse(array_keys($tables));
237 $this->smarty
->assign_by_ref('dropOrder', $dropOrder);
238 file_put_contents($this->sqlCodePath
. $fileName, $this->smarty
->fetch('drop.tpl'));
241 function generateNavigation() {
242 echo "Generating navigation file\n";
243 $this->reset_smarty_assignments();
244 file_put_contents($this->sqlCodePath
. "civicrm_navigation.mysql", $this->smarty
->fetch('civicrm_navigation.tpl'));
247 function generateLocalDataSql($db_version, $locales) {
248 $this->reset_smarty_assignments();
251 $oldTsLocale = $tsLocale;
252 foreach ($locales as $locale) {
253 echo "Generating data files for $locale\n";
255 $this->smarty
->assign('locale', $locale);
258 $data[] = $this->smarty
->fetch('civicrm_country.tpl');
259 $data[] = $this->smarty
->fetch('civicrm_state_province.tpl');
260 $data[] = $this->smarty
->fetch('civicrm_currency.tpl');
261 $data[] = $this->smarty
->fetch('civicrm_data.tpl');
262 $data[] = $this->smarty
->fetch('civicrm_navigation.tpl');
264 $data[] = " UPDATE civicrm_domain SET version = '$db_version';";
266 $data = implode("\n", $data);
268 $ext = ($locale != 'en_US' ?
".$locale" : '');
269 // write the initialize base-data sql script
270 file_put_contents($this->sqlCodePath
. "civicrm_data$ext.mysql", $data);
272 // write the acl sql script
273 file_put_contents($this->sqlCodePath
. "civicrm_acl$ext.mysql", $this->smarty
->fetch('civicrm_acl.tpl'));
275 $tsLocale = $oldTsLocale;
278 function generateSample() {
279 $this->reset_smarty_assignments();
280 $sample = $this->smarty
->fetch('civicrm_sample.tpl');
281 $sample .= $this->smarty
->fetch('civicrm_acl.tpl');
282 file_put_contents($this->sqlCodePath
. 'civicrm_sample.mysql', $sample);
285 function generateInstallLangs() {
286 // CRM-7161: generate install/langs.php from the languages template
287 // grep it for enabled languages and create a 'xx_YY' => 'Language name' $langs mapping
289 preg_match_all('/, 1, \'([a-z][a-z]_[A-Z][A-Z])\', \'..\', \{localize\}\'\{ts escape="sql"\}(.+)\{\/ts\}\'\{\/localize\}, /', file_get_contents('templates/languages.tpl'), $matches);
291 for ($i = 0; $i < count($matches[0]); $i++
) {
292 $langs[$matches[1][$i]] = $matches[2][$i];
294 file_put_contents('../install/langs.php', "<?php \$langs = unserialize('" . serialize($langs) . "');");
297 function generateDAOs($tables) {
298 foreach (array_keys($tables) as $name) {
299 $this->smarty
->clear_all_cache();
300 echo "Generating $name as " . $tables[$name]['fileName'] . "\n";
301 $this->reset_smarty_assignments();
303 $this->smarty
->assign_by_ref('table', $tables[$name]);
304 $php = $this->smarty
->fetch('dao.tpl');
306 $this->beautifier
->setInputString($php);
308 if (empty($tables[$name]['base'])) {
309 echo "No base defined for $name, skipping output generation\n";
313 $directory = $this->phpCodePath
. $tables[$name]['base'];
314 CRM_GenCode_Util_File
::createDir($directory);
315 $this->beautifier
->setOutputFile($directory . $tables[$name]['fileName']);
317 $this->beautifier
->process();
319 $this->beautifier
->save();
323 function generateSchemaStructure($tables) {
324 echo "Generating CRM_Core_I18n_SchemaStructure...\n";
327 foreach ($tables as $table) {
328 if ($table['localizable']) {
329 $columns[$table['name']] = array();
334 foreach ($table['fields'] as $field) {
335 if ($field['localizable']) {
336 $columns[$table['name']][$field['name']] = $field['sqlType'];
339 if (isset($table['index'])) {
340 foreach ($table['index'] as $index) {
341 if ($index['localizable']) {
342 $indices[$table['name']][$index['name']] = $index;
348 $this->reset_smarty_assignments();
349 $this->smarty
->assign_by_ref('columns', $columns);
350 $this->smarty
->assign_by_ref('indices', $indices);
352 $this->beautifier
->setInputString($this->smarty
->fetch('schema_structure.tpl'));
353 $this->beautifier
->setOutputFile($this->phpCodePath
. "/CRM/Core/I18n/SchemaStructure.php");
354 $this->beautifier
->process();
355 $this->beautifier
->save();
358 function generateTemplateVersion($dbVersion) {
359 file_put_contents($this->tplCodePath
. "/CRM/common/version.tpl", $dbVersion);
362 function findLocales() {
363 require_once 'CRM/Core/Config.php';
364 $config = CRM_Core_Config
::singleton(FALSE);
366 if (substr($config->gettextResourceDir
, 0, 1) === '/') {
367 $localeDir = $config->gettextResourceDir
;
370 $localeDir = '../' . $config->gettextResourceDir
;
372 if (file_exists($localeDir)) {
373 $config->gettextResourceDir
= $localeDir;
374 $locales = preg_grep('/^[a-z][a-z]_[A-Z][A-Z]$/', scandir($localeDir));
377 $localesMask = getenv('CIVICRM_LOCALES');
378 if (!empty($localesMask)) {
379 $mask = explode(',', $localesMask);
380 $locales = array_intersect($locales, $mask);
383 if (!in_array('en_US', $locales)) {
384 array_unshift($locales, 'en_US');
390 function setupCms($argCms, $db_version) {
391 // default cms is 'drupal', if not specified
392 $cms = isset($argCms) ?
strtolower($argCms) : 'drupal';
393 if (!in_array($cms, array(
394 'drupal', 'joomla'))) {
395 echo "Config file for '{$cms}' not known.";
398 elseif ($cms !== 'joomla') {
399 echo "Generating civicrm.config.php\n";
400 copy("../{$cms}/civicrm.config.php.{$cms}", '../civicrm.config.php');
403 echo "Generating civicrm-version file\n";
404 $this->smarty
->assign('db_version', $db_version);
405 $this->smarty
->assign('cms', ucwords($cms));
406 file_put_contents($this->phpCodePath
. "civicrm-version.php", $this->smarty
->fetch('civicrm_version.tpl'));
409 // -----------------------------
410 // ---- Schema manipulation ----
411 // -----------------------------
412 function &parseInput($file) {
413 $dom = new DomDocument();
416 $dbXML = simplexml_import_dom($dom);
420 function &getDatabase(&$dbXML) {
421 $database = array('name' => trim((string ) $dbXML->name
));
424 $this->checkAndAppend($attributes, $dbXML, 'character_set', 'DEFAULT CHARACTER SET ', '');
425 $this->checkAndAppend($attributes, $dbXML, 'collate', 'COLLATE ', '');
426 $database['attributes'] = $attributes;
428 $tableAttributes_modern = $tableAttributes_simple = '';
429 $this->checkAndAppend($tableAttributes_modern, $dbXML, 'table_type', 'ENGINE=', '');
430 $this->checkAndAppend($tableAttributes_simple, $dbXML, 'table_type', 'TYPE=', '');
431 $database['tableAttributes_modern'] = trim($tableAttributes_modern . ' ' . $attributes);
432 $database['tableAttributes_simple'] = trim($tableAttributes_simple);
434 $database['comment'] = $this->value('comment', $dbXML, '');
439 function &getTables(&$dbXML, &$database) {
441 foreach ($dbXML->tables
as $tablesXML) {
442 foreach ($tablesXML->table
as $tableXML) {
443 if ($this->value('drop', $tableXML, 0) > 0 and $this->value('drop', $tableXML, 0) <= $this->buildVersion
) {
447 if ($this->value('add', $tableXML, 0) <= $this->buildVersion
) {
448 $this->getTable($tableXML, $database, $tables);
456 function resolveForeignKeys(&$tables, &$classNames) {
457 foreach (array_keys($tables) as $name) {
458 $this->resolveForeignKey($tables, $classNames, $name);
462 function resolveForeignKey(&$tables, &$classNames, $name) {
463 if (!array_key_exists('foreignKey', $tables[$name])) {
467 foreach (array_keys($tables[$name]['foreignKey']) as $fkey) {
468 $ftable = $tables[$name]['foreignKey'][$fkey]['table'];
469 if (!array_key_exists($ftable, $classNames)) {
470 echo "$ftable is not a valid foreign key table in $name\n";
473 $tables[$name]['foreignKey'][$fkey]['className'] = $classNames[$ftable];
474 $tables[$name]['foreignKey'][$fkey]['fileName'] = str_replace('_', '/', $classNames[$ftable]) . '.php';
475 $tables[$name]['fields'][$fkey]['FKClassName'] = $classNames[$ftable];
479 function orderTables(&$tables) {
482 while (!empty($tables)) {
483 foreach (array_keys($tables) as $name) {
484 if ($this->validTable($tables, $ordered, $name)) {
485 $ordered[$name] = $tables[$name];
486 unset($tables[$name]);
493 function validTable(&$tables, &$valid, $name) {
494 if (!array_key_exists('foreignKey', $tables[$name])) {
498 foreach (array_keys($tables[$name]['foreignKey']) as $fkey) {
499 $ftable = $tables[$name]['foreignKey'][$fkey]['table'];
500 if (!array_key_exists($ftable, $valid) && $ftable !== $name) {
507 function getTable($tableXML, &$database, &$tables) {
508 $name = trim((string ) $tableXML->name
);
509 $klass = trim((string ) $tableXML->class);
510 $base = $this->value('base', $tableXML);
511 $sourceFile = "xml/schema/{$base}/{$klass}.xml";
512 $daoPath = "{$base}/DAO/";
513 $pre = str_replace('/', '_', $daoPath);
514 $this->classNames
[$name] = $pre . $klass;
516 $localizable = FALSE;
517 foreach ($tableXML->field
as $fieldXML) {
518 if ($fieldXML->localizable
) {
527 'sourceFile' => $sourceFile,
528 'fileName' => $klass . '.php',
529 'objectName' => $klass,
530 'labelName' => substr($name, 8),
531 'className' => $this->classNames
[$name],
532 'attributes_simple' => trim($database['tableAttributes_simple']),
533 'attributes_modern' => trim($database['tableAttributes_modern']),
534 'comment' => $this->value('comment', $tableXML),
535 'localizable' => $localizable,
536 'log' => $this->value('log', $tableXML, 'false'),
537 'archive' => $this->value('archive', $tableXML, 'false'),
541 foreach ($tableXML->field
as $fieldXML) {
542 if ($this->value('drop', $fieldXML, 0) > 0 and $this->value('drop', $fieldXML, 0) <= $this->buildVersion
) {
546 if ($this->value('add', $fieldXML, 0) <= $this->buildVersion
) {
547 $this->getField($fieldXML, $fields);
551 $table['fields'] = &$fields;
552 $table['hasEnum'] = FALSE;
553 foreach ($table['fields'] as $field) {
554 if ($field['crmType'] == 'CRM_Utils_Type::T_ENUM') {
555 $table['hasEnum'] = TRUE;
560 if ($this->value('primaryKey', $tableXML)) {
561 $this->getPrimaryKey($tableXML->primaryKey
, $fields, $table);
564 // some kind of refresh?
565 CRM_Core_Config
::singleton(FALSE);
566 if ($this->value('index', $tableXML)) {
568 foreach ($tableXML->index
as $indexXML) {
569 if ($this->value('drop', $indexXML, 0) > 0 and $this->value('drop', $indexXML, 0) <= $this->buildVersion
) {
573 $this->getIndex($indexXML, $fields, $index);
575 $table['index'] = &$index;
578 if ($this->value('foreignKey', $tableXML)) {
580 foreach ($tableXML->foreignKey
as $foreignXML) {
581 // print_r($foreignXML);
583 if ($this->value('drop', $foreignXML, 0) > 0 and $this->value('drop', $foreignXML, 0) <= $this->buildVersion
) {
586 if ($this->value('add', $foreignXML, 0) <= $this->buildVersion
) {
587 $this->getForeignKey($foreignXML, $fields, $foreign, $name);
590 $table['foreignKey'] = &$foreign;
593 if ($this->value('dynamicForeignKey', $tableXML)) {
594 $dynamicForeign = array();
595 foreach ($tableXML->dynamicForeignKey
as $foreignXML) {
596 if ($this->value('drop', $foreignXML, 0) > 0 and $this->value('drop', $foreignXML, 0) <= $this->buildVersion
) {
599 if ($this->value('add', $foreignXML, 0) <= $this->buildVersion
) {
600 $this->getDynamicForeignKey($foreignXML, $dynamicForeign, $name);
603 $table['dynamicForeignKey'] = $dynamicForeign;
606 $tables[$name] = &$table;
610 function getField(&$fieldXML, &$fields) {
611 $name = trim((string ) $fieldXML->name
);
612 $field = array('name' => $name, 'localizable' => $fieldXML->localizable
);
613 $type = (string ) $fieldXML->type
;
617 $field['length'] = (int) $fieldXML->length
;
618 $field['sqlType'] = "$type({$field['length']})";
619 $field['phpType'] = 'string';
620 $field['crmType'] = 'CRM_Utils_Type::T_STRING';
621 $field['size'] = $this->getSize($fieldXML);
625 $value = (string ) $fieldXML->values
;
626 $field['sqlType'] = 'enum(';
627 $field['values'] = array();
628 $field['enumValues'] = $value;
629 $values = explode(',', $value);
631 foreach ($values as $v) {
633 $field['values'][] = $v;
636 $field['sqlType'] .= ', ';
639 $field['sqlType'] .= "'$v'";
641 $field['sqlType'] .= ')';
642 $field['phpType'] = $field['sqlType'];
643 $field['crmType'] = 'CRM_Utils_Type::T_ENUM';
647 $field['sqlType'] = $field['phpType'] = $type;
648 $field['crmType'] = 'CRM_Utils_Type::T_' . strtoupper($type);
649 $field['rows'] = $this->value('rows', $fieldXML);
650 $field['cols'] = $this->value('cols', $fieldXML);
654 $field['sqlType'] = $field['phpType'] = $type;
655 $field['crmType'] = 'CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME';
659 // need this case since some versions of mysql do not have boolean as a valid column type and hence it
660 // is changed to tinyint. hopefully after 2 yrs this case can be removed.
661 $field['sqlType'] = 'tinyint';
662 $field['phpType'] = $type;
663 $field['crmType'] = 'CRM_Utils_Type::T_' . strtoupper($type);
667 $length = $fieldXML->length ?
$fieldXML->length
: '20,2';
668 $field['sqlType'] = 'decimal(' . $length . ')';
669 $field['phpType'] = 'float';
670 $field['crmType'] = 'CRM_Utils_Type::T_MONEY';
674 $field['sqlType'] = 'double';
675 $field['phpType'] = 'float';
676 $field['crmType'] = 'CRM_Utils_Type::T_FLOAT';
680 $field['sqlType'] = $field['phpType'] = $type;
681 if ($type == 'int unsigned') {
682 $field['crmType'] = 'CRM_Utils_Type::T_INT';
685 $field['crmType'] = 'CRM_Utils_Type::T_' . strtoupper($type);
690 $field['required'] = $this->value('required', $fieldXML);
691 $field['comment'] = $this->value('comment', $fieldXML);
692 $field['default'] = $this->value('default', $fieldXML);
693 $field['import'] = $this->value('import', $fieldXML);
694 if ($this->value('export', $fieldXML)) {
695 $field['export'] = $this->value('export', $fieldXML);
698 $field['export'] = $this->value('import', $fieldXML);
700 $field['rule'] = $this->value('rule', $fieldXML);
701 $field['title'] = $this->value('title', $fieldXML);
702 if (!$field['title']) {
703 $field['title'] = $this->composeTitle($name);
705 $field['headerPattern'] = $this->value('headerPattern', $fieldXML);
706 $field['dataPattern'] = $this->value('dataPattern', $fieldXML);
707 $field['uniqueName'] = $this->value('uniqueName', $fieldXML);
708 $field['pseudoconstant'] = $this->value('pseudoconstant', $fieldXML);
709 if(is_object($field['pseudoconstant'])){
710 //ok this is a bit long-winded but it gets there & is consistent with above approach
711 $field['pseudoconstant'] = array();
712 $validOptions = array(
713 // Fields can specify EITHER optionGroupName OR table, not both
714 // (since declaring optionGroupName means we are using the civicrm_option_value table)
717 // Optional additional params will be passed into CRM_Core_PseudoConstant::get()
722 foreach ($validOptions as $pseudoOption){
723 if(!empty($fieldXML->pseudoconstant
->$pseudoOption)){
724 $field['pseudoconstant'][$pseudoOption] = $this->value($pseudoOption, $fieldXML->pseudoconstant
);
728 $fields[$name] = &$field;
731 function composeTitle($name) {
732 $names = explode('_', strtolower($name));
734 for ($i = 0; $i < count($names); $i++
) {
735 if ($names[$i] === 'id' ||
$names[$i] === 'is') {
736 // id's do not get titles
740 if ($names[$i] === 'im') {
744 $names[$i] = ucfirst(trim($names[$i]));
747 $title = $title . ' ' . $names[$i];
752 function getPrimaryKey(&$primaryXML, &$fields, &$table) {
753 $name = trim((string ) $primaryXML->name
);
755 /** need to make sure there is a field of type name */
756 if (!array_key_exists($name, $fields)) {
757 echo "primary key $name in $table->name does not have a field definition, ignoring\n";
761 // set the autoincrement property of the field
762 $auto = $this->value('autoincrement', $primaryXML);
763 $fields[$name]['autoincrement'] = $auto;
766 'autoincrement' => $auto,
768 $table['primaryKey'] = &$primaryKey;
771 function getIndex(&$indexXML, &$fields, &$indices) {
772 //echo "\n\n*******************************************************\n";
773 //echo "entering getIndex\n";
776 // empty index name is fine
777 $indexName = trim((string)$indexXML->name
);
778 $index['name'] = $indexName;
779 $index['field'] = array();
782 foreach ($indexXML->fieldName
as $v) {
783 $fieldName = (string)($v);
784 $length = (string)($v['length']);
785 if (strlen($length) > 0) {
786 $fieldName = "$fieldName($length)";
788 $index['field'][] = $fieldName;
791 $index['localizable'] = FALSE;
792 foreach ($index['field'] as $fieldName) {
793 if (isset($fields[$fieldName]) and $fields[$fieldName]['localizable']) {
794 $index['localizable'] = TRUE;
799 // check for unique index
800 if ($this->value('unique', $indexXML)) {
801 $index['unique'] = TRUE;
804 //echo "\$index = \n";
807 // field array cannot be empty
808 if (empty($index['field'])) {
809 echo "No fields defined for index $indexName\n";
813 // all fieldnames have to be defined and should exist in schema.
814 foreach ($index['field'] as $fieldName) {
816 echo "Invalid field defination for index $indexName\n";
819 $parenOffset = strpos($fieldName, '(');
820 if ($parenOffset > 0) {
821 $fieldName = substr($fieldName, 0, $parenOffset);
823 if (!array_key_exists($fieldName, $fields)) {
824 echo "Table does not contain $fieldName\n";
826 CRM_GenCode_Util_File
::removeDir($this->compileDir
);
830 $indices[$indexName] = &$index;
833 function getForeignKey(&$foreignXML, &$fields, &$foreignKeys, &$currentTableName) {
834 $name = trim((string ) $foreignXML->name
);
836 /** need to make sure there is a field of type name */
837 if (!array_key_exists($name, $fields)) {
838 echo "foreign $name in $currentTableName does not have a field definition, ignoring\n";
842 /** need to check for existence of table and key **/
843 $table = trim($this->value('table', $foreignXML));
847 'uniqName' => "FK_{$currentTableName}_{$name}",
848 'key' => trim($this->value('key', $foreignXML)),
849 'import' => $this->value('import', $foreignXML, FALSE),
850 'export' => $this->value('import', $foreignXML, FALSE),
851 // we do this matching in a seperate phase (resolveForeignKeys)
853 'onDelete' => $this->value('onDelete', $foreignXML, FALSE),
855 $foreignKeys[$name] = &$foreignKey;
858 function getDynamicForeignKey(&$foreignXML, &$dynamicForeignKeys) {
860 'idColumn' => trim($foreignXML->idColumn
),
861 'typeColumn' => trim($foreignXML->typeColumn
),
862 'key' => trim($this->value('key', $foreignXML)),
864 $dynamicForeignKeys[] = $foreignKey;
867 protected function value($key, &$object, $default = NULL) {
868 if (isset($object->$key)) {
869 return (string ) $object->$key;
874 protected function checkAndAppend(&$attributes, &$object, $name, $pre = NULL, $post = NULL) {
875 if (!isset($object->$name)) {
879 $value = $pre . trim($object->$name) . $post;
880 $this->append($attributes, ' ', trim($value));
883 protected function append(&$str, $delim, $name) {
888 if (is_array($name)) {
889 foreach ($name as $n) {
906 $str .= $delim . $name;
912 * Sets the size property of a textfield
913 * See constants defined in CRM_Utils_Type for possible values
915 protected function getSize($fieldXML) {
916 // Extract from <size> tag if supplied
917 if ($this->value('size', $fieldXML)) {
918 $const = 'CRM_Utils_Type::' . strtoupper($fieldXML->size
);
919 if (defined($const)) {
923 // Infer from <length> tag if <size> was not explicitly set or was invalid
925 // This map is slightly different from CRM_Core_Form_Renderer::$_sizeMapper
926 // Because we usually want fields to render as smaller than their maxlength
936 foreach ($sizes as $length => $name) {
937 if ($fieldXML->length
<= $length) {
938 return "CRM_Utils_Type::$name";
941 return 'CRM_Utils_Type::HUGE';
945 * Clear the smarty cache and assign default values
947 function reset_smarty_assignments() {
948 $this->smarty
->clear_all_assign();
949 $this->smarty
->clear_all_cache();
950 $this->smarty
->assign('generated', "DO NOT EDIT. Generated by " . basename(__FILE__
));