CRM/Core/CodeGen/Specification.php

   1 <?php
   2
   3 /**
   4  * Read the schema specification and parse into internal data structures
   5  */
   6 class CRM_Core_CodeGen_Specification {
   7   public $tables;
   8   public $database;
   9
  10   protected $classNames;
  11
  12   /**
  13    * Read and parse.
  14    *
  15    * @param $schemaPath
  16    * @param string $buildVersion
  17    *   Which version of the schema to build.
  18    * @param bool $verbose
  19    */
  20   public function parse($schemaPath, $buildVersion, $verbose = TRUE) {
  21     $this->buildVersion = $buildVersion;
  22
  23     if ($verbose) {
  24       echo "Parsing schema description " . $schemaPath . "\n";
  25     }
  26     $dbXML = CRM_Core_CodeGen_Util_Xml::parse($schemaPath);
  27
  28     if ($verbose) {
  29       echo "Extracting database information\n";
  30     }
  31     $this->database = &$this->getDatabase($dbXML);
  32
  33     $this->classNames = [];
  34
  35     // TODO: peel DAO-specific stuff out of getTables, and spec reading into its own class
  36     if ($verbose) {
  37       echo "Extracting table information\n";
  38     }
  39     $this->tables = $this->getTables($dbXML, $this->database);
  40
  41     $this->resolveForeignKeys($this->tables, $this->classNames);
  42     $this->tables = $this->orderTables($this->tables);
  43
  44     // add archive tables here
  45     foreach ($this->tables as $name => $table) {
  46       if ($table['archive'] == 'true') {
  47         $name = 'archive_' . $table['name'];
  48         $table['name'] = $name;
  49         $table['archive'] = 'false';
  50         if (isset($table['foreignKey'])) {
  51           foreach ($table['foreignKey'] as $fkName => $fkValue) {
  52             if ($this->tables[$fkValue['table']]['archive'] == 'true') {
  53               $table['foreignKey'][$fkName]['table'] = 'archive_' . $table['foreignKey'][$fkName]['table'];
  54               $table['foreignKey'][$fkName]['uniqName']
  55                 = str_replace('FK_', 'FK_archive_', $table['foreignKey'][$fkName]['uniqName']);
  56             }
  57           }
  58           $archiveTables[$name] = $table;
  59         }
  60       }
  61     }
  62   }
  63
  64   /**
  65    * @param $dbXML
  66    *
  67    * @return array
  68    */
  69   public function &getDatabase(&$dbXML) {
  70     $database = ['name' => trim((string ) $dbXML->name)];
  71
  72     $attributes = '';
  73     $this->checkAndAppend($attributes, $dbXML, 'character_set', 'DEFAULT CHARACTER SET ', '');
  74     $this->checkAndAppend($attributes, $dbXML, 'collate', 'COLLATE ', '');
  75     $database['attributes'] = $attributes;
  76
  77     $tableAttributes_modern = $tableAttributes_simple = '';
  78     $this->checkAndAppend($tableAttributes_modern, $dbXML, 'table_type', 'ENGINE=', '');
  79     $this->checkAndAppend($tableAttributes_simple, $dbXML, 'table_type', 'TYPE=', '');
  80     $database['tableAttributes_modern'] = trim($tableAttributes_modern . ' ' . $attributes);
  81     $database['tableAttributes_simple'] = trim($tableAttributes_simple);
  82
  83     $database['comment'] = $this->value('comment', $dbXML, '');
  84
  85     return $database;
  86   }
  87
  88   /**
  89    * @param $dbXML
  90    * @param $database
  91    *
  92    * @return array
  93    */
  94   public function getTables($dbXML, &$database) {
  95     $tables = [];
  96     foreach ($dbXML->tables as $tablesXML) {
  97       foreach ($tablesXML->table as $tableXML) {
  98         if ($this->value('drop', $tableXML, 0) > 0 && version_compare($this->value('drop', $tableXML, 0), $this->buildVersion, '<=')) {
  99           continue;
 100         }
 101
 102         if (version_compare($this->value('add', $tableXML, 0), $this->buildVersion, '<=')) {
 103           $this->getTable($tableXML, $database, $tables);
 104         }
 105       }
 106     }
 107
 108     return $tables;
 109   }
 110
 111   /**
 112    * @param $tables
 113    * @param string $classNames
 114    */
 115   public function resolveForeignKeys(&$tables, &$classNames) {
 116     foreach (array_keys($tables) as $name) {
 117       $this->resolveForeignKey($tables, $classNames, $name);
 118     }
 119   }
 120
 121   /**
 122    * @param $tables
 123    * @param string $classNames
 124    * @param string $name
 125    */
 126   public function resolveForeignKey(&$tables, &$classNames, $name) {
 127     if (!array_key_exists('foreignKey', $tables[$name])) {
 128       return;
 129     }
 130
 131     foreach (array_keys($tables[$name]['foreignKey']) as $fkey) {
 132       $ftable = $tables[$name]['foreignKey'][$fkey]['table'];
 133       if (!array_key_exists($ftable, $classNames)) {
 134         echo "$ftable is not a valid foreign key table in $name\n";
 135         continue;
 136       }
 137       $tables[$name]['foreignKey'][$fkey]['className'] = $classNames[$ftable];
 138       $tables[$name]['foreignKey'][$fkey]['fileName'] = str_replace('_', '/', $classNames[$ftable]) . '.php';
 139       $tables[$name]['fields'][$fkey]['FKClassName'] = $classNames[$ftable];
 140     }
 141   }
 142
 143   /**
 144    * @param $tables
 145    *
 146    * @return array
 147    */
 148   public function orderTables(&$tables) {
 149     $ordered = [];
 150
 151     while (!empty($tables)) {
 152       foreach (array_keys($tables) as $name) {
 153         if ($this->validTable($tables, $ordered, $name)) {
 154           $ordered[$name] = $tables[$name];
 155           unset($tables[$name]);
 156         }
 157       }
 158     }
 159     return $ordered;
 160   }
 161
 162   /**
 163    * @param $tables
 164    * @param int $valid
 165    * @param string $name
 166    *
 167    * @return bool
 168    */
 169   public function validTable(&$tables, &$valid, $name) {
 170     if (!array_key_exists('foreignKey', $tables[$name])) {
 171       return TRUE;
 172     }
 173
 174     foreach (array_keys($tables[$name]['foreignKey']) as $fkey) {
 175       $ftable = $tables[$name]['foreignKey'][$fkey]['table'];
 176       if (!array_key_exists($ftable, $valid) && $ftable !== $name) {
 177         return FALSE;
 178       }
 179     }
 180     return TRUE;
 181   }
 182
 183   /**
 184    * @param $tableXML
 185    * @param $database
 186    * @param $tables
 187    */
 188   public function getTable($tableXML, &$database, &$tables) {
 189     $name = trim((string ) $tableXML->name);
 190     $klass = trim((string ) $tableXML->class);
 191     $base = $this->value('base', $tableXML);
 192     $sourceFile = "xml/schema/{$base}/{$klass}.xml";
 193     $daoPath = "{$base}/DAO/";
 194     $baoPath = __DIR__ . '/../../../' . str_replace(' ', '', "{$base}/BAO/");
 195     $pre = str_replace('/', '_', $daoPath);
 196     $this->classNames[$name] = $pre . $klass;
 197
 198     $localizable = FALSE;
 199     foreach ($tableXML->field as $fieldXML) {
 200       if ($fieldXML->localizable) {
 201         $localizable = TRUE;
 202         break;
 203       }
 204     }
 205
 206     $table = [
 207       'name' => $name,
 208       'base' => $daoPath,
 209       'sourceFile' => $sourceFile,
 210       'fileName' => $klass . '.php',
 211       'objectName' => $klass,
 212       'labelName' => substr($name, 8),
 213       'className' => $this->classNames[$name],
 214       'bao' => (file_exists($baoPath . $klass . '.php') ? str_replace('DAO', 'BAO', $this->classNames[$name]) : $this->classNames[$name]),
 215       'entity' => $klass,
 216       'attributes_simple' => trim($database['tableAttributes_simple']),
 217       'attributes_modern' => trim($database['tableAttributes_modern']),
 218       'comment' => $this->value('comment', $tableXML),
 219       'localizable' => $localizable,
 220       'log' => $this->value('log', $tableXML, 'false'),
 221       'archive' => $this->value('archive', $tableXML, 'false'),
 222     ];
 223
 224     $fields = [];
 225     foreach ($tableXML->field as $fieldXML) {
 226       if ($this->value('drop', $fieldXML, 0) > 0 && version_compare($this->value('drop', $fieldXML, 0), $this->buildVersion, '<=')) {
 227         continue;
 228       }
 229
 230       if (version_compare($this->value('add', $fieldXML, 0), $this->buildVersion, '<=')) {
 231         $this->getField($fieldXML, $fields);
 232       }
 233     }
 234
 235     $table['fields'] = &$fields;
 236
 237     if ($this->value('primaryKey', $tableXML)) {
 238       $this->getPrimaryKey($tableXML->primaryKey, $fields, $table);
 239     }
 240
 241     if ($this->value('index', $tableXML)) {
 242       $index = [];
 243       foreach ($tableXML->index as $indexXML) {
 244         if ($this->value('drop', $indexXML, 0) > 0 && version_compare($this->value('drop', $indexXML, 0), $this->buildVersion, '<=')) {
 245           continue;
 246         }
 247
 248         $this->getIndex($indexXML, $fields, $index);
 249       }
 250       CRM_Core_BAO_SchemaHandler::addIndexSignature($name, $index);
 251       $table['index'] = &$index;
 252     }
 253
 254     if ($this->value('foreignKey', $tableXML)) {
 255       $foreign = [];
 256       foreach ($tableXML->foreignKey as $foreignXML) {
 257
 258         if ($this->value('drop', $foreignXML, 0) > 0 && version_compare($this->value('drop', $foreignXML, 0), $this->buildVersion, '<=')) {
 259           continue;
 260         }
 261         if (version_compare($this->value('add', $foreignXML, 0), $this->buildVersion, '<=')) {
 262           $this->getForeignKey($foreignXML, $fields, $foreign, $name);
 263         }
 264       }
 265       $table['foreignKey'] = &$foreign;
 266     }
 267
 268     if ($this->value('dynamicForeignKey', $tableXML)) {
 269       $dynamicForeign = [];
 270       foreach ($tableXML->dynamicForeignKey as $foreignXML) {
 271         if ($this->value('drop', $foreignXML, 0) > 0 && version_compare($this->value('drop', $foreignXML, 0), $this->buildVersion, '<=')) {
 272           continue;
 273         }
 274         if (version_compare($this->value('add', $foreignXML, 0), $this->buildVersion, '<=')) {
 275           $this->getDynamicForeignKey($foreignXML, $dynamicForeign, $name);
 276         }
 277       }
 278       $table['dynamicForeignKey'] = $dynamicForeign;
 279     }
 280
 281     $tables[$name] = &$table;
 282   }
 283
 284   /**
 285    * @param $fieldXML
 286    * @param $fields
 287    */
 288   public function getField(&$fieldXML, &$fields) {
 289     $name = trim((string ) $fieldXML->name);
 290     $field = ['name' => $name, 'localizable' => ((bool) $fieldXML->localizable) ? 1 : 0];
 291     $type = (string ) $fieldXML->type;
 292     switch ($type) {
 293       case 'varchar':
 294       case 'char':
 295         $field['length'] = (int) $fieldXML->length;
 296         $field['sqlType'] = "$type({$field['length']})";
 297         $field['phpType'] = 'string';
 298         $field['crmType'] = 'CRM_Utils_Type::T_STRING';
 299         $field['size'] = $this->getSize($fieldXML);
 300         break;
 301
 302       case 'text':
 303         $field['sqlType'] = $field['phpType'] = $type;
 304         $field['crmType'] = 'CRM_Utils_Type::T_' . strtoupper($type);
 305         // CRM-13497 see fixme below
 306         $field['rows'] = isset($fieldXML->html) ? $this->value('rows', $fieldXML->html) : NULL;
 307         $field['cols'] = isset($fieldXML->html) ? $this->value('cols', $fieldXML->html) : NULL;
 308         break;
 309
 310       break;
 311
 312       case 'datetime':
 313         $field['sqlType'] = $field['phpType'] = $type;
 314         $field['crmType'] = 'CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME';
 315         break;
 316
 317       case 'boolean':
 318         // need this case since some versions of mysql do not have boolean as a valid column type and hence it
 319         // is changed to tinyint. hopefully after 2 yrs this case can be removed.
 320         $field['sqlType'] = 'tinyint';
 321         $field['phpType'] = 'bool';
 322         $field['crmType'] = 'CRM_Utils_Type::T_' . strtoupper($type);
 323         break;
 324
 325       case 'decimal':
 326         $length = $fieldXML->length ? $fieldXML->length : '20,2';
 327         $field['sqlType'] = 'decimal(' . $length . ')';
 328         $field['phpType'] = 'float';
 329         $field['crmType'] = 'CRM_Utils_Type::T_MONEY';
 330         $field['precision'] = $length . ',';
 331         break;
 332
 333       case 'float':
 334         $field['sqlType'] = 'double';
 335         $field['phpType'] = 'float';
 336         $field['crmType'] = 'CRM_Utils_Type::T_FLOAT';
 337         break;
 338
 339       default:
 340         $field['phpType'] = $this->value('phpType', $fieldXML, $type);
 341         $field['sqlType'] = $type;
 342         if ($type == 'int unsigned') {
 343           $field['phpType'] = 'int';
 344           $field['crmType'] = 'CRM_Utils_Type::T_INT';
 345         }
 346         else {
 347           $field['crmType'] = $this->value('crmType', $fieldXML, 'CRM_Utils_Type::T_' . strtoupper($type));
 348         }
 349         break;
 350     }
 351
 352     $field['required'] = $this->value('required', $fieldXML);
 353     $field['collate'] = $this->value('collate', $fieldXML);
 354     $field['comment'] = $this->value('comment', $fieldXML);
 355     $field['default'] = $this->value('default', $fieldXML);
 356     $field['import'] = $this->value('import', $fieldXML);
 357     if ($this->value('export', $fieldXML)) {
 358       $field['export'] = $this->value('export', $fieldXML);
 359     }
 360     else {
 361       $field['export'] = $this->value('import', $fieldXML);
 362     }
 363     $field['rule'] = $this->value('rule', $fieldXML);
 364     $field['title'] = $this->value('title', $fieldXML);
 365     if (!$field['title']) {
 366       $field['title'] = $this->composeTitle($name);
 367     }
 368     $field['headerPattern'] = $this->value('headerPattern', $fieldXML);
 369     $field['dataPattern'] = $this->value('dataPattern', $fieldXML);
 370     $field['uniqueName'] = $this->value('uniqueName', $fieldXML);
 371     $field['uniqueTitle'] = $this->value('uniqueTitle', $fieldXML);
 372     $field['serialize'] = $this->value('serialize', $fieldXML);
 373     $field['html'] = $this->value('html', $fieldXML);
 374     if (isset($fieldXML->permission)) {
 375       $field['permission'] = trim($this->value('permission', $fieldXML));
 376       $field['permission'] = $field['permission'] ? array_filter(array_map('trim', explode(',', $field['permission']))) : [];
 377       if (isset($fieldXML->permission->or)) {
 378         $field['permission'][] = array_filter(array_map('trim', explode(',', $fieldXML->permission->or)));
 379       }
 380     }
 381     if (!empty($field['html'])) {
 382       $validOptions = [
 383         'type',
 384         'formatType',
 385         'label',
 386         /* Fixme: prior to CRM-13497 these were in a flat structure
 387         // CRM-13497 moved them to be nested within 'html' but there's no point
 388         // making that change in the DAOs right now since we are in the process of
 389         // moving to docrtine anyway.
 390         // So translating from nested xml back to flat structure for now.
 391         'rows',
 392         'cols',
 393         'size', */
 394       ];
 395       $field['html'] = [];
 396       foreach ($validOptions as $htmlOption) {
 397         if (!empty($fieldXML->html->$htmlOption)) {
 398           $field['html'][$htmlOption] = $this->value($htmlOption, $fieldXML->html);
 399         }
 400       }
 401     }
 402
 403     // in multilingual context popup, we need extra information to create appropriate widget
 404     if ($fieldXML->localizable) {
 405       if (isset($fieldXML->html)) {
 406         $field['widget'] = (array) $fieldXML->html;
 407       }
 408       else {
 409         // default
 410         $field['widget'] = ['type' => 'Text'];
 411       }
 412       if (isset($fieldXML->required)) {
 413         $field['widget']['required'] = $this->value('required', $fieldXML);
 414       }
 415     }
 416     if (isset($fieldXML->localize_context)) {
 417       $field['localize_context'] = $fieldXML->localize_context;
 418     }
 419     $field['pseudoconstant'] = $this->value('pseudoconstant', $fieldXML);
 420     if (!empty($field['pseudoconstant'])) {
 421       //ok this is a bit long-winded but it gets there & is consistent with above approach
 422       $field['pseudoconstant'] = [];
 423       $validOptions = [
 424         // Fields can specify EITHER optionGroupName OR table, not both
 425         // (since declaring optionGroupName means we are using the civicrm_option_value table)
 426         'optionGroupName',
 427         'table',
 428         // If table is specified, keyColumn and labelColumn are also required
 429         'keyColumn',
 430         'labelColumn',
 431         // Non-translated machine name for programmatic lookup. Defaults to 'name' if that column exists
 432         'nameColumn',
 433         // Column to fetch in "abbreviate" context
 434         'abbrColumn',
 435         // Where clause snippet (will be joined to the rest of the query with AND operator)
 436         'condition',
 437         // callback function incase of static arrays
 438         'callback',
 439         // Path to options edit form
 440         'optionEditPath',
 441       ];
 442       foreach ($validOptions as $pseudoOption) {
 443         if (!empty($fieldXML->pseudoconstant->$pseudoOption)) {
 444           $field['pseudoconstant'][$pseudoOption] = $this->value($pseudoOption, $fieldXML->pseudoconstant);
 445         }
 446       }
 447       if (!isset($field['pseudoconstant']['optionEditPath']) && !empty($field['pseudoconstant']['optionGroupName'])) {
 448         $field['pseudoconstant']['optionEditPath'] = 'civicrm/admin/options/' . $field['pseudoconstant']['optionGroupName'];
 449       }
 450       // For now, fields that have option lists that are not in the db can simply
 451       // declare an empty pseudoconstant tag and we'll add this placeholder.
 452       // That field's BAO::buildOptions fn will need to be responsible for generating the option list
 453       if (empty($field['pseudoconstant'])) {
 454         $field['pseudoconstant'] = 'not in database';
 455       }
 456     }
 457     $fields[$name] = &$field;
 458   }
 459
 460   /**
 461    * @param string $name
 462    *
 463    * @return string
 464    */
 465   public function composeTitle($name) {
 466     $names = explode('_', strtolower($name));
 467     $title = '';
 468     for ($i = 0; $i < count($names); $i++) {
 469       if ($names[$i] === 'id' || $names[$i] === 'is') {
 470         // id's do not get titles
 471         return NULL;
 472       }
 473
 474       if ($names[$i] === 'im') {
 475         $names[$i] = 'IM';
 476       }
 477       else {
 478         $names[$i] = ucfirst(trim($names[$i]));
 479       }
 480
 481       $title = $title . ' ' . $names[$i];
 482     }
 483     return trim($title);
 484   }
 485
 486   /**
 487    * @param object $primaryXML
 488    * @param array $fields
 489    * @param array $table
 490    */
 491   public function getPrimaryKey(&$primaryXML, &$fields, &$table) {
 492     $name = trim((string ) $primaryXML->name);
 493
 494     // set the autoincrement property of the field
 495     $auto = $this->value('autoincrement', $primaryXML);
 496     if (isset($fields[$name])) {
 497       $fields[$name]['autoincrement'] = $auto;
 498     }
 499     $fields[$name]['autoincrement'] = $auto;
 500     $primaryKey = [
 501       'name' => $name,
 502       'autoincrement' => $auto,
 503     ];
 504
 505     // populate fields
 506     foreach ($primaryXML->fieldName as $v) {
 507       $fieldName = (string) ($v);
 508       $length = (string) ($v['length']);
 509       if (strlen($length) > 0) {
 510         $fieldName = "$fieldName($length)";
 511       }
 512       $primaryKey['field'][] = $fieldName;
 513     }
 514
 515     // when field array is empty set it to the name of the primary key.
 516     if (empty($primaryKey['field'])) {
 517       $primaryKey['field'][] = $name;
 518     }
 519
 520     // all fieldnames have to be defined and should exist in schema.
 521     foreach ($primaryKey['field'] as $fieldName) {
 522       if (!$fieldName) {
 523         echo "Invalid field defination for index $name\n";
 524         return;
 525       }
 526       $parenOffset = strpos($fieldName, '(');
 527       if ($parenOffset > 0) {
 528         $fieldName = substr($fieldName, 0, $parenOffset);
 529       }
 530       if (!array_key_exists($fieldName, $fields)) {
 531         echo "Table does not contain $fieldName\n";
 532         print_r($fields);
 533         exit();
 534       }
 535     }
 536
 537     $table['primaryKey'] = &$primaryKey;
 538   }
 539
 540   /**
 541    * @param $indexXML
 542    * @param $fields
 543    * @param $indices
 544    */
 545   public function getIndex(&$indexXML, &$fields, &$indices) {
 546     //echo "\n\n*******************************************************\n";
 547     //echo "entering getIndex\n";
 548
 549     $index = [];
 550     // empty index name is fine
 551     $indexName = trim((string) $indexXML->name);
 552     $index['name'] = $indexName;
 553     $index['field'] = [];
 554
 555     // populate fields
 556     foreach ($indexXML->fieldName as $v) {
 557       $fieldName = (string) ($v);
 558       $length = (string) ($v['length']);
 559       if (strlen($length) > 0) {
 560         $fieldName = "$fieldName($length)";
 561       }
 562       $index['field'][] = $fieldName;
 563     }
 564
 565     $index['localizable'] = FALSE;
 566     foreach ($index['field'] as $fieldName) {
 567       if (isset($fields[$fieldName]) and $fields[$fieldName]['localizable']) {
 568         $index['localizable'] = TRUE;
 569         break;
 570       }
 571     }
 572
 573     // check for unique index
 574     if ($this->value('unique', $indexXML)) {
 575       $index['unique'] = TRUE;
 576     }
 577
 578     // field array cannot be empty
 579     if (empty($index['field'])) {
 580       echo "No fields defined for index $indexName\n";
 581       return;
 582     }
 583
 584     // all fieldnames have to be defined and should exist in schema.
 585     foreach ($index['field'] as $fieldName) {
 586       if (!$fieldName) {
 587         echo "Invalid field defination for index $indexName\n";
 588         return;
 589       }
 590       $parenOffset = strpos($fieldName, '(');
 591       if ($parenOffset > 0) {
 592         $fieldName = substr($fieldName, 0, $parenOffset);
 593       }
 594       if (!array_key_exists($fieldName, $fields)) {
 595         echo "Table does not contain $fieldName\n";
 596         print_r($fields);
 597         exit();
 598       }
 599     }
 600     $indices[$indexName] = &$index;
 601   }
 602
 603   /**
 604    * @param $foreignXML
 605    * @param $fields
 606    * @param $foreignKeys
 607    * @param string $currentTableName
 608    */
 609   public function getForeignKey(&$foreignXML, &$fields, &$foreignKeys, &$currentTableName) {
 610     $name = trim((string ) $foreignXML->name);
 611
 612     /** need to make sure there is a field of type name */
 613     if (!array_key_exists($name, $fields)) {
 614       echo "foreign $name in $currentTableName does not have a field definition, ignoring\n";
 615       return;
 616     }
 617
 618     /** need to check for existence of table and key **/
 619     $table = trim($this->value('table', $foreignXML));
 620     $foreignKey = [
 621       'name' => $name,
 622       'table' => $table,
 623       'uniqName' => "FK_{$currentTableName}_{$name}",
 624       'key' => trim($this->value('key', $foreignXML)),
 625       'import' => $this->value('import', $foreignXML, FALSE),
 626       'export' => $this->value('import', $foreignXML, FALSE),
 627       // we do this matching in a separate phase (resolveForeignKeys)
 628       'className' => NULL,
 629       'onDelete' => $this->value('onDelete', $foreignXML, FALSE),
 630     ];
 631     $foreignKeys[$name] = &$foreignKey;
 632   }
 633
 634   /**
 635    * @param $foreignXML
 636    * @param $dynamicForeignKeys
 637    */
 638   public function getDynamicForeignKey(&$foreignXML, &$dynamicForeignKeys) {
 639     $foreignKey = [
 640       'idColumn' => trim($foreignXML->idColumn),
 641       'typeColumn' => trim($foreignXML->typeColumn),
 642       'key' => trim($this->value('key', $foreignXML)),
 643     ];
 644     $dynamicForeignKeys[] = $foreignKey;
 645   }
 646
 647   /**
 648    * @param $key
 649    * @param $object
 650    * @param null $default
 651    *
 652    * @return null|string
 653    */
 654   protected function value($key, &$object, $default = NULL) {
 655     if (isset($object->$key)) {
 656       return (string ) $object->$key;
 657     }
 658     return $default;
 659   }
 660
 661   /**
 662    * @param $attributes
 663    * @param $object
 664    * @param string $name
 665    * @param null $pre
 666    * @param null $post
 667    */
 668   protected function checkAndAppend(&$attributes, &$object, $name, $pre = NULL, $post = NULL) {
 669     if (!isset($object->$name)) {
 670       return;
 671     }
 672
 673     $value = $pre . trim($object->$name) . $post;
 674     $this->append($attributes, ' ', trim($value));
 675   }
 676
 677   /**
 678    * @param $str
 679    * @param $delim
 680    * @param $name
 681    */
 682   protected function append(&$str, $delim, $name) {
 683     if (empty($name)) {
 684       return;
 685     }
 686
 687     if (is_array($name)) {
 688       foreach ($name as $n) {
 689         if (empty($n)) {
 690           continue;
 691         }
 692         if (empty($str)) {
 693           $str = $n;
 694         }
 695         else {
 696           $str .= $delim . $n;
 697         }
 698       }
 699     }
 700     else {
 701       if (empty($str)) {
 702         $str = $name;
 703       }
 704       else {
 705         $str .= $delim . $name;
 706       }
 707     }
 708   }
 709
 710   /**
 711    * Sets the size property of a textfield.
 712    *
 713    * @param string $fieldXML
 714    *
 715    * @return null|string
 716    */
 717   protected function getSize($fieldXML) {
 718     // Extract from <size> tag if supplied
 719     if (!empty($fieldXML->html) && $this->value('size', $fieldXML->html)) {
 720       return $this->value('size', $fieldXML->html);
 721     }
 722     // Infer from <length> tag if <size> was not explicitly set or was invalid
 723     // This map is slightly different from CRM_Core_Form_Renderer::$_sizeMapper
 724     // Because we usually want fields to render as smaller than their maxlength
 725     $sizes = [
 726       2 => 'TWO',
 727       4 => 'FOUR',
 728       6 => 'SIX',
 729       8 => 'EIGHT',
 730       16 => 'TWELVE',
 731       32 => 'MEDIUM',
 732       64 => 'BIG',
 733     ];
 734     foreach ($sizes as $length => $name) {
 735       if ($fieldXML->length <= $length) {
 736         return "CRM_Utils_Type::$name";
 737       }
 738     }
 739     return 'CRM_Utils_Type::HUGE';
 740   }
 741
 742 }