CRM/Core/CodeGen/DAO.php

   1 <?php
   2
   3 /**
   4  * Create DAO ORM classes.
   5  */
   6 class CRM_Core_CodeGen_DAO extends CRM_Core_CodeGen_BaseTask {
   7
   8   /**
   9    * @var string
  10    */
  11   public $name;
  12
  13   /**
  14    * @var string
  15    */
  16   private $tableChecksum;
  17
  18   /**
  19    * @var string
  20    */
  21   private $raw;
  22
  23   /**
  24    * CRM_Core_CodeGen_DAO constructor.
  25    *
  26    * @param \CRM_Core_CodeGen_Main $config
  27    * @param string $name
  28    */
  29   public function __construct($config, $name) {
  30     parent::__construct($config);
  31     $this->name = $name;
  32   }
  33
  34   /**
  35    * @return bool
  36    *   TRUE if an update is needed.
  37    */
  38   public function needsUpdate() {
  39     if (!file_exists($this->getAbsFileName())) {
  40       return TRUE;
  41     }
  42
  43     if ($this->getTableChecksum() !== self::extractRegex($this->getAbsFileName(), ';\(GenCodeChecksum:([a-zA-Z0-9]+)\);')) {
  44       return TRUE;
  45     }
  46
  47     return !$this->isApproxPhpMatch(
  48       file_get_contents($this->getAbsFileName()),
  49       $this->getRaw());
  50   }
  51
  52   /**
  53    * Run generator.
  54    */
  55   public function run() {
  56     echo "Generating {$this->name} as " . $this->getRelFileName() . "\n";
  57
  58     if (empty($this->tables[$this->name]['base'])) {
  59       echo "No base defined for {$this->name}, skipping output generation\n";
  60       return;
  61     }
  62
  63     $template = new CRM_Core_CodeGen_Util_Template('php');
  64     $template->assign('table', $this->tables[$this->name]);
  65     $template->assign('genCodeChecksum', $this->getTableChecksum());
  66     $template->run('dao.tpl', $this->getAbsFileName());
  67   }
  68
  69   /**
  70    * Generate the raw PHP code for the DAO.
  71    *
  72    * @return string
  73    */
  74   public function getRaw() {
  75     if (!$this->raw) {
  76       $template = new CRM_Core_CodeGen_Util_Template('php');
  77       $template->assign('table', $this->tables[$this->name]);
  78       $template->assign('genCodeChecksum', 'NEW');
  79       $this->raw = $template->fetch('dao.tpl');
  80     }
  81     return $this->raw;
  82   }
  83
  84   /**
  85    * Get relative file name.
  86    *
  87    * @return string
  88    */
  89   public function getRelFileName() {
  90     return $this->tables[$this->name]['fileName'];
  91   }
  92
  93   /**
  94    * Get the absolute file name.
  95    *
  96    * @return string
  97    */
  98   public function getAbsFileName() {
  99     $directory = $this->config->phpCodePath . $this->tables[$this->name]['base'];
 100     CRM_Core_CodeGen_Util_File::createDir($directory);
 101     $absFileName = $directory . $this->getRelFileName();
 102     return $absFileName;
 103   }
 104
 105   /**
 106    * Get a unique signature for the table/schema.
 107    *
 108    * @return string
 109    */
 110   protected function getTableChecksum() {
 111     if (!$this->tableChecksum) {
 112       CRM_Utils_Array::flatten($this->tables[$this->name], $flat);
 113       ksort($flat);
 114       $this->tableChecksum = md5(json_encode($flat));
 115     }
 116     return $this->tableChecksum;
 117   }
 118
 119 }