forked from propelorm/Propel2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ObjectBuilder.php
1748 lines (1567 loc) · 62.4 KB
/
ObjectBuilder.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
namespace Propel\Generator\Builder\Om;
use Propel\Generator\Exception\EngineException;
use Propel\Generator\Model\Column;
use Propel\Generator\Model\ForeignKey;
use Propel\Generator\Model\IdMethod;
use Propel\Generator\Model\PropelTypes;
use Propel\Generator\Model\Table;
use Propel\Generator\Platform\MssqlPlatform;
use Propel\Generator\Platform\MysqlPlatform;
use Propel\Generator\Platform\OraclePlatform;
use Propel\Generator\Platform\PlatformInterface;
use Propel\Generator\Platform\SqlsrvPlatform;
/**
* Generates a PHP5 base Object class for user object model (OM).
*
* This class produces the base object class (e.g. BaseMyTable) which contains
* all the custom-built accessor and setter methods.
*
* @author Hans Lellelid <hans@xmpl.org>
*/
class ObjectBuilder extends AbstractObjectBuilder
{
private $twig;
public function __construct(Table $table)
{
parent::__construct($table);
$loader = new \Twig_Loader_Filesystem(__DIR__ . '/templates/');
$this->twig = new \Twig_Environment($loader, ['autoescape' => false, 'strict_variables' => true, 'cache' => sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'propel2-cache', 'auto_reload' => true]);
$this->twig->addFilter('addSlashes', new \Twig_SimpleFilter('addSlashes', 'addslashes'));
$this->twig->addFilter('lcfirst', new \Twig_SimpleFilter('lcfirst', 'lcfirst'));
$this->twig->addFilter('ucfirst', new \Twig_SimpleFilter('ucfirst', 'ucfirst'));
$this->twig->addFilter('indent', new \Twig_SimpleFilter('indent', function($string) {
$lines = explode(PHP_EOL, $string);
$output = '';
foreach($lines as $line) {
$output .= ' ' . $line . PHP_EOL;
}
return $output;
}));
$this->twig->addFilter(
'varExport',
new \Twig_SimpleFilter('varExport', function ($input) {
return var_export($input, true);
})
);
foreach($table->getBehaviors() as $behavior) {
$path = $behavior->getTemplateDirectory();
if($path !== null) {
$loader->prependPath($behavior->getTemplateDirectory(), $behavior->getTemplateNamespace());
}
}
}
/**
* Returns the package for the base object classes.
*
* @return string
*/
public function getPackage()
{
return parent::getPackage() . ".Base";
}
/**
* Returns the namespace for the base class.
*
* @return string
* @see Propel\Generator\Builder\Om.AbstractOMBuilder::getNamespace()
*/
public function getNamespace()
{
if ($namespace = parent::getNamespace()) {
return $namespace . '\\Base';
}
return 'Base';
}
/**
* Returns default key type.
*
* If not presented in configuration default will be 'TYPE_PHPNAME'
*
* @return string
*/
public function getDefaultKeyType()
{
$defaultKeyType = $this->getBuildProperty('defaultKeyType') ? $this->getBuildProperty('defaultKeyType') : 'phpName';
return "TYPE_".strtoupper($defaultKeyType);
}
/**
* Returns the name of the current class being built.
*
* @return string
*/
public function getUnprefixedClassName()
{
return $this->getStubObjectBuilder()->getUnprefixedClassName();
}
/**
* Validates the current table to make sure that it won't result in
* generated code that will not parse.
*
* This method may emit warnings for code which may cause problems
* and will throw exceptions for errors that will definitely cause
* problems.
*/
protected function validateModel()
{
parent::validateModel();
$table = $this->getTable();
// Check to see whether any generated foreign key names
// will conflict with column names.
$colPhpNames = array();
$fkPhpNames = array();
foreach ($table->getColumns() as $col) {
$colPhpNames[] = $col->getPhpName();
}
foreach ($table->getForeignKeys() as $fk) {
$fkPhpNames[] = $this->getFKPhpNameAffix($fk, false);
}
$intersect = array_intersect($colPhpNames, $fkPhpNames);
if (!empty($intersect)) {
throw new EngineException("One or more of your column names for [" . $table->getName() . "] table conflict with foreign key names (" . implode(", ", $intersect) . ")");
}
// Check foreign keys to see if there are any foreign keys that
// are also matched with an inversed referencing foreign key
// (this is currently unsupported behavior)
// see: http://propel.phpdb.org/trac/ticket/549
foreach ($table->getForeignKeys() as $fk) {
if ($fk->isMatchedByInverseFK()) {
throw new EngineException(sprintf('The 1:1 relationship expressed by foreign key %s is defined in both directions; Propel does not currently support this (if you must have both foreign key constraints, consider adding this constraint with a custom SQL file.)', $fk->getName()));
}
}
}
/**
* Returns the appropriate formatter (from platform) for a date/time column.
*
* @TODO: made public becuase use in template
* @param Column $column
* @return string
*/
public function getTemporalFormatter(Column $column)
{
$fmt = null;
if ($column->getType() === PropelTypes::DATE) {
$fmt = $this->getPlatform()->getDateFormatter();
} elseif ($column->getType() === PropelTypes::TIME) {
$fmt = $this->getPlatform()->getTimeFormatter();
} elseif ($column->getType() === PropelTypes::TIMESTAMP) {
$fmt = $this->getPlatform()->getTimestampFormatter();
}
return $fmt;
}
/**
* Returns the type-casted and stringified default value for the specified
* Column. This only works for scalar default values currently.
*
* TODO: made this public because template
*
* @param Column $column
* @throws EngineException
* @return string
*/
public function getDefaultValueString(Column $column)
{
$defaultValue = var_export(null, true);
$val = $column->getPhpDefaultValue();
if (null === $val) {
return $defaultValue;
}
if ($column->isTemporalType()) {
$fmt = $this->getTemporalFormatter($column);
try {
if (!($this->getPlatform() instanceof MysqlPlatform &&
($val === '0000-00-00 00:00:00' || $val === '0000-00-00'))) {
// while technically this is not a default value of NULL,
// this seems to be closest in meaning.
$defDt = new \DateTime($val);
$defaultValue = var_export($defDt->format($fmt), true);
}
} catch (\Exception $exception) {
// prevent endless loop when timezone is undefined
date_default_timezone_set('America/Los_Angeles');
throw new EngineException(sprintf('Unable to parse default temporal value "%s" for column "%s"', $column->getDefaultValueString(), $column->getFullyQualifiedName()), $exception);
}
} elseif ($column->isEnumType()) {
$valueSet = $column->getValueSet();
if (!in_array($val, $valueSet)) {
throw new EngineException(sprintf('Default Value "%s" is not among the enumerated values', $val));
}
$defaultValue = array_search($val, $valueSet);
} elseif ($column->isPhpPrimitiveType()) {
settype($val, $column->getPhpType());
$defaultValue = var_export($val, true);
} elseif ($column->isPhpObjectType()) {
$defaultValue = 'new '.$column->getPhpType().'(' . var_export($val, true) . ')';
} elseif ($column->isPhpArrayType()) {
$defaultValue = var_export($val, true);
} else {
throw new EngineException("Cannot get default value string for " . $column->getFullyQualifiedName());
}
return $defaultValue;
}
/**
* Adds class phpdoc comment and opening of class.
*
* @param string &$script
*/
protected function addClassOpen(&$script)
{
$table = $this->getTable();
$tableName = $table->getName();
$tableDesc = $table->getDescription();
if (null !== ($parentClass = $this->getBehaviorContent('parentClass')) ||
null !== ($parentClass = ClassTools::classname($this->getBaseClass()))) {
$parentClass = ' extends '.$parentClass;
}
if ($this->getBuildProperty('addClassLevelComment')) {
$script .= "
/**
* Base class that represents a row from the '$tableName' table.
*
* $tableDesc
*";
if ($this->getBuildProperty('addTimeStamp')) {
$now = strftime('%c');
$script .= "
* This class was autogenerated by Propel " . $this->getBuildProperty('version') . " on:
*
* $now
*";
}
$script .= "
* @package propel.generator.".$this->getPackage()."
*/";
}
$script .= "
abstract class ".$this->getUnqualifiedClassName().$parentClass." implements ActiveRecordInterface ";
if ($interface = $this->getInterface()) {
$script .= ", Child" . ClassTools::classname($interface);
if ($interface !== ClassTools::classname($interface)) {
$this->declareClass($interface);
} else {
$this->declareClassFromBuilder($this->getInterfaceBuilder());
}
}
$script .= "
{";
}
/**
* Specifies the methods that are added as part of the basic OM class.
* This can be overridden by subclasses that wish to add more methods.
*
* @param string &$script
* @see ObjectBuilder::addClassBody()
*/
protected function addClassBody(&$script)
{
$this->declareClassFromBuilder($this->getStubObjectBuilder());
$this->declareClassFromBuilder($this->getStubQueryBuilder());
$this->declareClassFromBuilder($this->getTableMapBuilder());
$this->declareClasses(
'\Exception',
'\PDO',
'\Propel\Runtime\Exception\PropelException',
'\Propel\Runtime\Connection\ConnectionInterface',
'\Propel\Runtime\Collection\Collection',
'\Propel\Runtime\Collection\ObjectCollection',
'\Propel\Runtime\Exception\BadMethodCallException',
'\Propel\Runtime\Exception\PropelException',
'\Propel\Runtime\ActiveQuery\Criteria',
'\Propel\Runtime\ActiveQuery\ModelCriteria',
'\Propel\Runtime\ActiveRecord\ActiveRecordInterface',
'\Propel\Runtime\Parser\AbstractParser',
'\Propel\Runtime\Propel',
'\Propel\Runtime\Map\TableMap',
'\Propel\Runtime\Util\PropelDateTime',
'\Propel\Runtime\ActiveQuery\PropelQuery'
);
$script .= $this->twig->render('Object/_classBody.php.twig', ['builder' => $this]);
$this->addCrossFKMethods($script);
$this->addClearAllReferences($script);
// apply behaviors
$this->applyBehaviorModifier('objectMethods', $script, " ");
}
/**
* Closes class.
*
* @param string &$script
*/
protected function addClassClose(&$script)
{
$script .= "
}
";
$this->applyBehaviorModifier('objectFilter', $script, "");
}
/**
* Adds a tester method for an array column.
*
* @param string &$script
* @param Column $column
*/
protected function addHasArrayElement(&$script, Column $column)
{
$clo = $column->getLowercasedName();
$cfc = $column->getPhpName();
$visibility = $column->getAccessorVisibility();
$singularPhpName = rtrim($cfc, 's');
$script .= "
/**
* Test the presence of a value in the [$clo] array column value.
* @param mixed \$value
* ".$column->getDescription();
if ($column->isLazyLoad()) {
$script .= "
* @param ConnectionInterface An optional ConnectionInterface connection to use for fetching this lazy-loaded column.";
}
$script .= "
* @return boolean
*/
$visibility function has$singularPhpName(\$value";
if ($column->isLazyLoad()) {
$script .= ", ConnectionInterface \$con = null";
}
$script .= ")
{
return in_array(\$value, \$this->get$cfc(";
if ($column->isLazyLoad()) {
$script .= "\$con";
}
$script .= "));
} // has$singularPhpName()
";
}
/**
* Adds the function body for the lazy loader method.
*
* @param string &$script
* @param Column $column
* TODO: made this public because of twig usage
*/
public function addLazyLoaderBody(Column $column)
{
$script = '';
$platform = $this->getPlatform();
$clo = $column->getLowercasedName();
// pdo_sqlsrv driver requires the use of PDOStatement::bindColumn() or a hex string will be returned
if ($column->getType() === PropelTypes::BLOB && $platform instanceof SqlsrvPlatform) {
$script .= "
\$c = \$this->buildPkeyCriteria();
\$c->addSelectColumn(".$this->getColumnConstant($column).");
try {
\$row = array(0 => null);
\$dataFetcher = ".$this->getQueryClassName()."::create(null, \$c)->setFormatter(ModelCriteria::FORMAT_STATEMENT)->find(\$con);
if (\$dataFetcher instanceof PDODataFetcher) {
\$dataFetcher->bindColumn(1, \$row[0], PDO::PARAM_LOB, 0, PDO::SQLSRV_ENCODING_BINARY);
}
\$row = \$dataFetcher->fetch(PDO::FETCH_BOUND);
\$dataFetcher->close();";
} else {
$script .= "
\$c = \$this->buildPkeyCriteria();
\$c->addSelectColumn(".$this->getColumnConstant($column).");
try {
\$dataFetcher = ".$this->getQueryClassName()."::create(null, \$c)->setFormatter(ModelCriteria::FORMAT_STATEMENT)->find(\$con);
\$row = \$dataFetcher->fetch();
\$dataFetcher->close();";
}
$script .= "
\$firstColumn = \$row ? current(\$row) : null;
";
if ($column->getType() === PropelTypes::CLOB && $platform instanceof OraclePlatform) {
// PDO_OCI returns a stream for CLOB objects, while other PDO adapters return a string...
$script .= "
if (\$firstColumn) {
\$this->$clo = stream_get_contents(\$firstColumn);
}";
} elseif ($column->isLobType() && !$platform->hasStreamBlobImpl()) {
$script .= "
if (\$firstColumn !== null) {
\$this->$clo = fopen('php://memory', 'r+');
fwrite(\$this->$clo, \$firstColumn);
rewind(\$this->$clo);
} else {
\$this->$clo = null;
}";
} elseif ($column->isPhpPrimitiveType()) {
$script .= "
\$this->$clo = (\$firstColumn !== null) ? (".$column->getPhpType().") \$firstColumn : null;";
} elseif ($column->isPhpObjectType()) {
$script .= "
\$this->$clo = (\$firstColumn !== null) ? new ".$column->getPhpType()."(\$firstColumn) : null;";
} else {
$script .= "
\$this->$clo = \$firstColumn;";
}
$script .= "
\$this->".$clo."_isLoaded = true;
} catch (Exception \$e) {
throw new PropelException(\"Error loading value for [$clo] column on demand.\", 0, \$e);
}";
return $script;
}
/**
* Adds a push method for an array column.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
*
* @TOdo: made public for twig
*/
public function addAddArrayElement(Column $col)
{
$script = '';
$clo = $col->getLowercasedName();
$cfc = $col->getPhpName();
$visibility = $col->getAccessorVisibility();
$singularPhpName = rtrim($cfc, 's');
$script .= "
/**
* Adds a value to the [$clo] array column value.
* @param mixed \$value
* ".$col->getDescription();
if ($col->isLazyLoad()) {
$script .= "
* @param ConnectionInterface An optional ConnectionInterface connection to use for fetching this lazy-loaded column.";
}
$script .= "
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
*/
$visibility function add$singularPhpName(\$value";
if ($col->isLazyLoad()) {
$script .= ", ConnectionInterface \$con = null";
}
$script .= ")
{
\$currentArray = \$this->get$cfc(";
if ($col->isLazyLoad()) {
$script .= "\$con";
}
$script .= ");
\$currentArray []= \$value;
\$this->set$cfc(\$currentArray);
return \$this;
} // add$singularPhpName()
";
return $script;
}
/**
* Adds a remove method for an array column.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
*
* @Todo: made public for twig
*/
public function addRemoveArrayElement(Column $col)
{
$script = '';
$clo = $col->getLowercasedName();
$cfc = $col->getPhpName();
$visibility = $col->getAccessorVisibility();
$singularPhpName = rtrim($cfc, 's');
$script .= "
/**
* Removes a value from the [$clo] array column value.
* @param mixed \$value
* ".$col->getDescription();
if ($col->isLazyLoad()) {
$script .= "
* @param ConnectionInterface An optional ConnectionInterface connection to use for fetching this lazy-loaded column.";
}
$script .= "
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
*/
$visibility function remove$singularPhpName(\$value";
if ($col->isLazyLoad()) {
$script .= ", ConnectionInterface \$con = null";
}
// we want to reindex the array, so array_ functions are not the best choice
$script .= ")
{
\$targetArray = array();
foreach (\$this->get$cfc(";
if ($col->isLazyLoad()) {
$script .= "\$con";
}
$script .= ") as \$element) {
if (\$element != \$value) {
\$targetArray []= \$element;
}
}
\$this->set$cfc(\$targetArray);
return \$this;
} // remove$singularPhpName()
";
return $script;
}
public function getInvalidTemporalString(Column $column)
{
if ($this->getPlatform() instanceof MysqlPlatform) {
if($column->getType() === PropelTypes::TIMESTAMP) {
return '0000-00-00 00:00:00';
} elseif($column->getType() === PropelTypes::DATE) {
return '0000-00-00';
}
}
return null;
}
/**
* Constructs variable name for fkey-related objects.
* @param ForeignKey $fk
* @return string
*/
public function getFKVarName(ForeignKey $fk)
{
return 'a' . $this->getFKPhpNameAffix($fk, false);
}
/**
* Constructs variable name for objects which referencing current table by specified foreign key.
* @param ForeignKey $fk
* @return string
*/
public function getRefFKCollVarName(ForeignKey $fk)
{
return 'coll' . $this->getRefFKPhpNameAffix($fk, true);
}
/**
* Constructs variable name for single object which references current table by specified foreign key
* which is ALSO a primary key (hence one-to-one relationship).
* @param ForeignKey $fk
* @return string
*/
public function getPKRefFKVarName(ForeignKey $fk)
{
return 'single' . $this->getRefFKPhpNameAffix($fk, false);
}
/**
* Adds the class attributes that are needed to store fkey related objects.
* @param string &$script The script will be modified in this method.
* @param ForeignKey $fk
*/
protected function addFKAttributes(&$script, ForeignKey $fk)
{
$className = $fk->getForeignTable()->getPhpName();
$varName = $this->getFKVarName($fk);
$script .= "
/**
* @var $className
*/
protected $".$varName.";
";
}
/**
* Adds the accessor (getter) method for getting an fkey related object.
* @param string &$script The script will be modified in this method.
* @param ForeignKey $fk
*/
public function addFKAccessor(ForeignKey $fk)
{
$script = '';
$table = $this->getTable();
$varName = $this->getFKVarName($fk);
$fkQueryBuilder = $this->getNewStubQueryBuilder($fk->getForeignTable());
$fkObjectBuilder = $this->getNewObjectBuilder($fk->getForeignTable())->getStubObjectBuilder();
$className = $this->getClassNameFromBuilder($fkObjectBuilder); // get the ClassName that has maybe a prefix
$and = '';
$conditional = '';
$localColumns = array(); // foreign key local attributes names
// If the related columns are a primary key on the foreign table
// then use findPk() instead of doSelect() to take advantage
// of instance pooling
$findPk = $fk->isForeignPrimaryKey();
foreach ($fk->getLocalColumns() as $columnName) {
$lfmap = $fk->getLocalForeignMapping();
$foreignColumn = $fk->getForeignTable()->getColumn($lfmap[$columnName]);
$column = $table->getColumn($columnName);
$cptype = $column->getPhpType();
$clo = $column->getLowercasedName();
$localColumns[$foreignColumn->getPosition()] = '$this->'.$clo;
if ($cptype == "integer" || $cptype == "float" || $cptype == "double") {
$conditional .= $and . "\$this->". $clo ." != 0";
} elseif ($cptype == "string") {
$conditional .= $and . "(\$this->" . $clo ." !== \"\" && \$this->".$clo." !== null)";
} else {
$conditional .= $and . "\$this->" . $clo ." !== null";
}
$and = " && ";
}
ksort($localColumns); // restoring the order of the foreign PK
$localColumns = count($localColumns) > 1 ?
('array('.implode(', ', $localColumns).')') : reset($localColumns);
$script .= "
/**
* Get the associated $className object
*
* @param ConnectionInterface \$con Optional Connection object.
* @return $className The associated $className object.
* @throws PropelException
*/
public function get".$this->getFKPhpNameAffix($fk, false)."(ConnectionInterface \$con = null)
{";
$script .= "
if (\$this->$varName === null && ($conditional)) {";
if ($findPk) {
$script .= "
\$this->$varName = ".$this->getClassNameFromBuilder($fkQueryBuilder)."::create()->findPk($localColumns, \$con);";
} else {
$script .= "
\$this->$varName = ".$this->getClassNameFromBuilder($fkQueryBuilder)."::create()
->filterBy" . $this->getRefFKPhpNameAffix($fk, $plural = false) . "(\$this) // here
->findOne(\$con);";
}
if ($fk->isLocalPrimaryKey()) {
$script .= "
// Because this foreign key represents a one-to-one relationship, we will create a bi-directional association.
\$this->{$varName}->set".$this->getRefFKPhpNameAffix($fk, false)."(\$this);";
} else {
$script .= "
/* The following can be used additionally to
guarantee the related object contains a reference
to this object. This level of coupling may, however, be
undesirable since it could result in an only partially populated collection
in the referenced object.
\$this->{$varName}->add".$this->getRefFKPhpNameAffix($fk, true)."(\$this);
*/";
}
$script .= "
}
return \$this->$varName;
}
";
return $script;
} // addFKAccessor
/**
* Adds a convenience method for setting a related object by specifying the primary key.
* This can be used in conjunction with the getPrimaryKey() for systems where nothing is known
* about the actual objects being related.
* @param string &$script The script will be modified in this method.
* @param ForeignKey $fk
*/
protected function addFKByKeyMutator(&$script, ForeignKey $fk)
{
$table = $this->getTable();
$methodAffix = $this->getFKPhpNameAffix($fk);
$script .= "
/**
* Provides convenient way to set a relationship based on a
* key. e.g.
* <code>\$bar->setFooKey(\$foo->getPrimaryKey())</code>
*";
if (count($fk->getLocalColumns()) > 1) {
$script .= "
* Note: It is important that the xml schema used to create this class
* maintains consistency in the order of related columns between
* ".$table->getName()." and ". $fk->getName().".
* If for some reason this is impossible, this method should be
* overridden in <code>".$table->getPhpName()."</code>.";
}
$script .= "
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
* @throws PropelException
*/
public function set".$methodAffix."Key(\$key)
{
";
if (count($fk->getLocalColumns()) > 1) {
$i = 0;
foreach ($fk->getLocalColumns() as $colName) {
$col = $table->getColumn($colName);
$fktype = $col->getPhpType();
$script .= "
\$this->set".$col->getPhpName()."( ($fktype) \$key[$i] );
";
$i++;
} /* foreach */
} else {
$lcols = $fk->getLocalColumns();
$colName = $lcols[0];
$col = $table->getColumn($colName);
$fktype = $col->getPhpType();
$script .= "
\$this->set".$col->getPhpName()."( ($fktype) \$key);
";
}
$script .= "
return \$this;
}
";
} // addFKByKeyMutator()
/**
* Adds the attributes used to store objects that have referrer fkey relationships to this object.
* <code>protected collVarName;</code>
* <code>private lastVarNameCriteria = null;</code>
* @param string &$script The script will be modified in this method.
* @param ForeignKey $refFK
*/
protected function addRefFKAttributes(&$script, ForeignKey $refFK)
{
$joinedTableObjectBuilder = $this->getNewObjectBuilder($refFK->getTable());
$className = $joinedTableObjectBuilder->getObjectClassName();
if ($refFK->isLocalPrimaryKey()) {
$script .= "
/**
* @var $className one-to-one related $className object
*/
protected $".$this->getPKRefFKVarName($refFK).";
";
} else {
$script .= "
/**
* @var ObjectCollection|{$className}[] Collection to store aggregation of $className objects.
*/
protected $" . $this->getRefFKCollVarName($refFK) . ";
protected $" . $this->getRefFKCollVarName($refFK) . "Partial;
";
}
}
protected function addCrossFKAttributes(&$script, ForeignKey $crossFK)
{
$joinedTableObjectBuilder = $this->getNewObjectBuilder($crossFK->getForeignTable());
$className = $joinedTableObjectBuilder->getObjectClassName();
$script .= "
/**
* @var {$className}[] Collection to store aggregation of $className objects.
*/
protected $" . $this->getCrossFKVarName($crossFK) . ";
";
}
protected function addScheduledForDeletionAttribute(&$script, $fkName)
{
$fkName = lcfirst($fkName);
$script .= "
/**
* An array of objects scheduled for deletion.
* @var ObjectCollection
*/
protected \${$fkName}ScheduledForDeletion = null;
";
}
protected function addCrossFkScheduledForDeletion(&$script, ForeignKey $refFK, ForeignKey $crossFK)
{
$queryClassName = $this->getRefFKPhpNameAffix($refFK, false) . 'Query';
$relatedName = $this->getFKPhpNameAffix($crossFK, true);
$lowerRelatedName = lcfirst($relatedName);
$lowerSingleRelatedName = lcfirst($this->getFKPhpNameAffix($crossFK, false));
$middelFks = $refFK->getTable()->getForeignKeys();
$isFirstPk = ($middelFks[0]->getForeignTableCommonName() == $this->getTable()->getCommonName());
$script .= "
if (\$this->{$lowerRelatedName}ScheduledForDeletion !== null) {
if (!\$this->{$lowerRelatedName}ScheduledForDeletion->isEmpty()) {
\$pks = array();
\$pk = \$this->getPrimaryKey();
foreach (\$this->{$lowerRelatedName}ScheduledForDeletion->getPrimaryKeys(false) as \$remotePk) {";
if ($isFirstPk) {
$script .= "
\$pks[] = array(\$pk, \$remotePk);";
} else {
$script .= "
\$pks[] = array(\$remotePk, \$pk);";
}
$script .= "
}
$queryClassName::create()
->filterByPrimaryKeys(\$pks)
->delete(\$con);
\$this->{$lowerRelatedName}ScheduledForDeletion = null;
}
foreach (\$this->get{$relatedName}() as \${$lowerSingleRelatedName}) {
if (\${$lowerSingleRelatedName}->isModified()) {
\${$lowerSingleRelatedName}->save(\$con);
}
}
} elseif (\$this->coll{$relatedName}) {
foreach (\$this->coll{$relatedName} as \${$lowerSingleRelatedName}) {
if (\${$lowerSingleRelatedName}->isModified()) {
\${$lowerSingleRelatedName}->save(\$con);
}
}
}
";
}
protected function addRefFkScheduledForDeletion(&$script, ForeignKey $refFK)
{
$relatedName = $this->getRefFKPhpNameAffix($refFK, $plural = true);
$lowerRelatedName = lcfirst($relatedName);
$lowerSingleRelatedName = lcfirst($this->getRefFKPhpNameAffix($refFK, $plural = false));
$queryClassName = $this->getNewStubQueryBuilder($refFK->getTable())->getClassname();
$script .= "
if (\$this->{$lowerRelatedName}ScheduledForDeletion !== null) {
if (!\$this->{$lowerRelatedName}ScheduledForDeletion->isEmpty()) {";
if ($refFK->isLocalColumnsRequired() || ForeignKey::CASCADE === $refFK->getOnDelete()) {
$script .= "
$queryClassName::create()
->filterByPrimaryKeys(\$this->{$lowerRelatedName}ScheduledForDeletion->getPrimaryKeys(false))
->delete(\$con);";
} else {
$script .= "
foreach (\$this->{$lowerRelatedName}ScheduledForDeletion as \${$lowerSingleRelatedName}) {
// need to save related object because we set the relation to null
\${$lowerSingleRelatedName}->save(\$con);
}";
}
$script .= "
\$this->{$lowerRelatedName}ScheduledForDeletion = null;
}
}
";
}
/**
* @Todo: made public for use in template
*/
public function getCrossFKVarName(ForeignKey $crossFK)
{
return 'coll' . $this->getFKPhpNameAffix($crossFK, true);
}
protected function addCrossFKMethods(&$script)
{
foreach ($this->getTable()->getCrossFks() as $fkList) {
list($refFK, $crossFK) = $fkList;
$this->declareClassFromBuilder($this->getNewStubObjectBuilder($crossFK->getForeignTable()), 'Child');
$this->declareClassFromBuilder($this->getNewStubQueryBuilder($crossFK->getForeignTable()));
$this->addCrossFKClear($script, $crossFK);
$this->addCrossFKInit($script, $crossFK);
$this->addCrossFKGet($script, $refFK, $crossFK);
$this->addCrossFKSet($script, $refFK, $crossFK);
$this->addCrossFKCount($script, $refFK, $crossFK);
$this->addCrossFKAdd($script, $refFK, $crossFK);
$this->addCrossFKDoAdd($script, $refFK, $crossFK);
$this->addCrossFKRemove($script, $refFK, $crossFK);
}
}
/**
* Adds the method that clears the referrer fkey collection.
* @param string &$script The script will be modified in this method.
* @param ForeignKey $crossFK
*/
protected function addCrossFKClear(&$script, ForeignKey $crossFK)
{
$relCol = $this->getFKPhpNameAffix($crossFK, true);
$collName = $this->getCrossFKVarName($crossFK);
$script .= "
/**
* Clears out the {$collName} collection
*
* This does not modify the database; however, it will remove any associated objects, causing
* them to be refetched by subsequent calls to accessor method.
*
* @return void
* @see add{$relCol}()
*/
public function clear{$relCol}()
{
\$this->$collName = null; // important to set this to NULL since that means it is uninitialized
\$this->{$collName}Partial = null;
}
";
} // addRefererClear()
/**
* Adds the method that initializes the referrer fkey collection.
* @param string &$script The script will be modified in this method.
* @param ForeignKey $crossFK
*/
protected function addCrossFKInit(&$script, ForeignKey $crossFK)
{
$relCol = $this->getFKPhpNameAffix($crossFK, true);
$collName = $this->getCrossFKVarName($crossFK);
$relatedObjectClassName = $this->getClassNameFromBuilder($this->getNewStubObjectBuilder($crossFK->getForeignTable()), true);
$script .= "
/**
* Initializes the $collName collection.
*
* By default this just sets the $collName collection to an empty collection (like clear$relCol());
* however, you may wish to override this method in your stub class to provide setting appropriate
* to your application -- for example, setting the initial array to the values stored in database.
*
* @return void
*/
public function init$relCol()
{
\$this->$collName = new ObjectCollection();
\$this->{$collName}->setModel('$relatedObjectClassName');
}
";
}