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