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 <?php
namespace Alpha\Model\Type;
use Alpha\Util\Helper\Validator;
use Alpha\Exception\IllegalArguementException;
use Alpha\Model\ActiveRecord;
use Alpha\Exception\FailedLookupCreateException;
use ReflectionClass;
/**
* The Relation complex data type.
*
* @since 1.0
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
class Relation extends Type implements TypeInterface
{
/**
* The name of the business object class which this class is related to.
*
* @var string
*
* @since 1.0
*/
private $relatedClass;
/**
* The name of the fields of the business object class by which this class is related by.
*
* @var string
*
* @since 1.0
*/
private $relatedClassField;
/**
* The name of the field from the related business object class which is displayed by the selection widget.
*
* @var string
*
* @since 1.0
*/
private $relatedClassDisplayField;
/**
* An array of fields to use the values of while rendering related display values via the selection widget.
*
* @var array
*
* @since 1.0
*/
private $relatedClassHeaderFields = array();
/**
* The name of the business object class on the left of a MANY-TO-MANY relation.
*
* @var string
*
* @since 1.0
*/
private $relatedClassLeft;
/**
* The name of the field from the related business object class on the left of a
* MANY-TO-MANY relation which is displayed by the selection widget.
*
* @var string
*
* @since 1.0
*/
private $relatedClassLeftDisplayField;
/**
* The name of the business object class on the right of a MANY-TO-MANY relation.
*
* @var string
*
* @since 1.0
*/
private $relatedClassRight;
/**
* The name of the field from the related business object class on the right of a
* MANY-TO-MANY relation which is displayed by the selection widget.
*
* @var string
*
* @since 1.0
*/
private $relatedClassRightDisplayField;
/**
* The type of relation ('MANY-TO-ONE' or 'ONE-TO-MANY' or 'ONE-TO-ONE' or 'MANY-TO-MANY').
*
* @var string
*
* @since 1.0
*/
private $relationType;
/**
* In the case of MANY-TO-MANY relationship, a lookup object will be required.
*
* @var \Alpha\Model\Type\RelationLookup
*
* @since 1.0
*/
private $lookup;
/**
* In the case of MANY-TO-MANY relationship, this transient array can be used to hold the IDs of related records.
*
* @var array
*
* @since 2.0
*/
private $IDs = array();
/**
* When building a relation with the TagObject record, set this to the name of the tagged class.
*
* @var string
*
* @since 1.0
*/
private $taggedClass;
/**
* An array of the allowable relationship types ('MANY-TO-ONE' or 'ONE-TO-MANY' or 'ONE-TO-ONE' or 'MANY-TO-MANY').
*
* @var array
*
* @since 1.0
*/
private $allowableRelationTypes = array('MANY-TO-ONE', 'ONE-TO-MANY', 'ONE-TO-ONE', 'MANY-TO-MANY');
/**
* The ID value of the related object. In the special case of a MANY-TO-MANY
* relation, contains the ID of the object on the current, accessing side. Can contain NULL.
*
* @var mixed
*
* @since 1.0
*/
private $value = null;
/**
* The validation rule for the Relation type.
*
* @var string
*
* @since 1.0
*/
private $validationRule;
/**
* The error message for the Relation type when validation fails.
*
* @var string
*
* @since 1.0
*/
protected $helper;
/**
* The size of the value for the this Relation.
*
* @var int
*
* @since 1.0
*/
private $size = 11;
/**
* The absolute maximum size of the value for the this Relation.
*
* @var int
*
* @since 1.0
*/
const MAX_SIZE = 11;
/**
* Constructor.
*
* @since 1.0
*/
public function __construct()
{
$this->validationRule = Validator::REQUIRED_INTEGER;
$this->helper = ' not a valid Relation value! A maximum of '.$this->size.' characters is allowed.';
}
/**
* Set the name of the business object class that this class is related to.
*
* @param string $RC
* @param string $side Only required for MANY-TO-MANY relations
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setRelatedClass($RC, $side = '')
{
if (in_array($RC, ActiveRecord::getRecordClassNames())) {
switch ($side) {
case '':
$this->relatedClass = $RC;
break;
case 'left':
$this->relatedClassLeft = $RC;
break;
case 'right':
$this->relatedClassRight = $RC;
break;
default:
throw new IllegalArguementException('The side parameter ['.$RC.'] is not valid!');
}
} else {
throw new IllegalArguementException('The class ['.$RC.'] is not defined anywhere!');
}
}
/**
* Get the name of the business object class that this class is related to.
*
* @param string $side
*
* @return string
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function getRelatedClass($side = '')
{
switch ($side) {
case '':
return $this->relatedClass;
break;
case 'left':
return $this->relatedClassLeft;
break;
case 'right':
return $this->relatedClassRight;
break;
default:
throw new IllegalArguementException('The side parameter ['.$side.'] is not valid!');
}
}
/**
* Setter for the field of the related class.
*
* @param string $RCF
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setRelatedClassField($RCF)
{
// use reflection to sure the related class has the field $RCF
$reflection = new ReflectionClass($this->relatedClass);
$properties = $reflection->getProperties();
$fieldFound = false;
foreach ($properties as $propObj) {
if ($RCF == $propObj->name) {
$fieldFound = true;
break;
}
}
if ($fieldFound) {
$this->relatedClassField = $RCF;
} else {
throw new IllegalArguementException('The field ['.$RCF.'] was not found in the class ['.$this->relatedClass.']');
}
}
/**
* Getter for the field of the related class.
*
* @return string
*
* @since 1.0
*/
public function getRelatedClassField()
{
return $this->relatedClassField;
}
/**
* Setter for ONE-TO-MANY relations, which sets the header fields to
* render from the related class.
*
* @param array $fieldNames
*
* @since 1.0
*/
public function setRelatedClassHeaderFields($fieldNames)
{
$this->relatedClassHeaderFields = $fieldNames;
}
/**
* Getter for the selection widget field headings of the related class.
*
* @return array
*
* @since 1.0
*/
public function getRelatedClassHeaderFields()
{
return $this->relatedClassHeaderFields;
}
/**
* Setter for the display field from the related class.
*
* @param string $RCDF
* @param string $side Only required for MANY-TO-MANY relations
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setRelatedClassDisplayField($RCDF, $side = '')
{
switch ($side) {
case '':
$this->relatedClassDisplayField = $RCDF;
break;
case 'left':
$this->relatedClassLeftDisplayField = $RCDF;
break;
case 'right':
$this->relatedClassRightDisplayField = $RCDF;
break;
default:
throw new IllegalArguementException('The side paramter ['.$RC.'] is not valid!');
}
}
/**
* Getter for the display field from the related class.
*
* @param string $side Only required for MANY-TO-MANY relations
*
* @return string
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function getRelatedClassDisplayField($side = '')
{
switch ($side) {
case '':
return $this->relatedClassDisplayField;
break;
case 'left':
return $this->relatedClassLeftDisplayField;
break;
case 'right':
return $this->relatedClassRightDisplayField;
break;
default:
throw new IllegalArguementException('The side paramter ['.$RC.'] is not valid!');
}
}
/**
* Setter for the relation type.
*
* @param string $RT
*
* @throws \Alpha\Exception\IllegalArguementException
* @throws \Alpha\Exception\FailedLookupCreateException
*
* @since 1.0
*/
public function setRelationType($RT)
{
if (in_array($RT, $this->allowableRelationTypes)) {
$this->relationType = $RT;
if ($RT == 'MANY-TO-MANY') {
try {
$this->lookup = new RelationLookup($this->relatedClassLeft, $this->relatedClassRight);
} catch (FailedLookupCreateException $flce) {
throw $flce;
} catch (IllegalArguementException $iae) {
throw $iae;
}
}
} else {
throw new IllegalArguementException('Relation type of ['.$RT.'] is invalid!');
}
}
/**
* Getter for the relation type.
*
* @return string
*
* @since 1.0
*/
public function getRelationType()
{
return $this->relationType;
}
/**
* Setter for the value ID of this relation.
*
* @param int $val
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setValue($val)
{
if (empty($val)) {
$this->value = null;
} else {
if (!Validator::isInteger($val)) {
throw new IllegalArguementException("[$val]".$this->helper);
}
if (mb_strlen($val) <= $this->size) {
$this->value = str_pad($val, 11, '0', STR_PAD_LEFT);
} else {
throw new IllegalArguementException("[$val]".$this->helper);
}
}
}
/**
* Getter for the array of IDs used by MANY-TO-MANY instances.
*
* @return array
*
* @since 2.0
*/
public function getRelatedIDs()
{
return $this->IDs;
}
/**
* Setter for the array of IDs used by MANY-TO-MANY instances.
*
* @param array $IDs
*
* @since 2.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setRelatedIDs($IDs)
{
if (is_array($IDs)) {
$this->IDs = $IDs;
} else {
throw new IllegalArguementException('An array must be provided to setRelatedIDs()!');
}
}
/**
* Getter for the Relation value.
*
* @return string
*
* @since 1.0
*/
public function getValue()
{
return $this->value;
}
/**
* Get the validation rule.
*
* @return string
*
* @since 1.0
*/
public function getRule()
{
return $this->validationRule;
}
/**
* Setter to override the default validation rule.
*
* @param string $rule
*
* @since 1.0
*/
public function setRule($rule)
{
$this->validationRule = $rule;
}
/**
* Getter for the display value of the related class field. In the case of a
* MANY-TO-MANY Relation, a comma-seperated sorted list of values is returned.
*
* @param string $accessingClassName Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types)
*
* @return string
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function getRelatedClassDisplayFieldValue($accessingClassName = '')
{
if ($this->relationType == 'MANY-TO-MANY') {
/*
* 1. Use RelationLookup to get IDs of related objects
* 2. Load related objects
* 3. Access the value of the field on the object to build the
* comma-seperated list.
*/
if (empty($this->lookup)) {
throw new IllegalArguementException('Tried to load related MANY-TO-MANY fields but no RelationLookup set on the Relation object!');
}
if (empty($accessingClassName)) {
throw new IllegalArguementException('Tried to load related MANY-TO-MANY fields but no accessingClassName parameter set on the call to getRelatedClassDisplayFieldValue!');
}
// load objects on the right from accessing on the left
if ($accessingClassName == $this->relatedClassLeft) {
$obj = new $this->relatedClassRight();
$lookupObjects = $this->lookup->loadAllByAttribute('leftID', $this->value);
$values = array();
foreach ($lookupObjects as $lookupObject) {
$obj->load($lookupObject->get('rightID'));
array_push($values, $obj->get($this->relatedClassRightDisplayField));
}
// sort array, then return as comma-seperated string
asort($values);
return implode(',', $values);
}
// load objects on the left from accessing on the right
if ($accessingClassName == $this->relatedClassRight) {
$obj = new $this->relatedClassLeft();
$lookupObjects = $this->lookup->loadAllByAttribute('rightID', $this->value);
$values = array();
foreach ($lookupObjects as $lookupObject) {
$obj->load($lookupObject->get('leftID'));
array_push($values, $obj->get($this->relatedClassLeftDisplayField));
}
// sort array, then return as comma-seperated string
asort($values);
return implode(',', $values);
}
} else {
$obj = new $this->relatedClass();
// making sure we have an object to load
if (empty($this->value) || $this->value == '00000000000') {
return '';
} else {
$obj->load($this->value);
return $obj->get($this->relatedClassDisplayField);
}
}
}
/**
* For one-to-many and many-to-many relations, get an array of records on the other side. For one-to-one
* relations, get the record (Alpha\Model\ActiveRecord instance) on the other side.
*
* string $accessingClassName Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types)
*
* @return array|Alpha\Model\ActiveRecord
*
* @since 3.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function getRelated($accessingClassName = '')
{
if ($this->relationType == 'ONE-TO-ONE') {
if (!class_exists($this->relatedClass)) {
throw new IllegalArguementException('Could not load the definition for the ActiveRecord class ['.$this->relatedClass.']');
}
$record = new $this->relatedClass();
$record->loadByAttribute($this->getRelatedClassField(), $this->getValue());
return $record;
}
if ($this->relationType == 'ONE-TO-MANY') {
if ($this->getValue() == '') { // if the value is empty, then return an empty array
return array();
}
$record = new $this->relatedClass();
if ($this->relatedClass == 'Alpha\Model\Tag') {
$records = $record->loadTags($this->taggedClass, $this->getValue());
} else {
$records = $record->loadAllByAttribute($this->getRelatedClassField(), $this->getValue());
}
return $records;
} else { // MANY-TO-MANY
if (empty($this->lookup)) {
throw new IllegalArguementException('Tried to load related MANY-TO-MANY objects but no RelationLookup set on the Relation object!');
}
if (empty($accessingClassName)) {
throw new IllegalArguementException('Tried to load related MANY-TO-MANY objects but no accessingClassName parameter set on the call to getRelated!');
}
$records = array();
// load objects on the right from accessing on the left
if ($accessingClassName == $this->relatedClassLeft) {
$lookups = $this->lookup->loadAllByAttribute('leftID', $this->value);
foreach ($lookups as $lookup) {
$record = new $this->relatedClassRight();
$record->load($lookup->get('rightID'));
array_push($records, $record);
}
}
// load objects on the left from accessing on the right
if ($accessingClassName == $this->relatedClassRight && count($records) == 0) {
$lookups = $this->lookup->loadAllByAttribute('rightID', $this->value);
foreach ($lookups as $lookup) {
$record = new $this->relatedClassLeft();
$record->load($lookup->get('leftID'));
array_push($records, $record);
}
}
return $records;
}
}
/**
* Get the allowable size of the Relation in the database field.
*
* @return int
*
* @since 1.0
*/
public function getSize()
{
return $this->size;
}
/**
* Get the lookup object if available (only on MANY-TO-MANY relations, null otherwise).
*
* @return RelationLookup
*
* @since 1.0
*/
public function getLookup()
{
return $this->lookup;
}
/**
* Gets the side ('left' or 'right') of the passed classname on the current Relation object.
*
* @param string $RecordClassname
*
* @return string
*
* @since 1.0
*
* @throws \Alpha\Model\Type\IllegalArguementException
*/
public function getSide($RecordClassname)
{
if ($RecordClassname == $this->relatedClassLeft) {
return 'left';
} elseif ($RecordClassname == $this->relatedClassRight) {
return 'right';
} else {
throw new IllegalArguementException('Error trying to determine the MANY-TO-MANY relationship side for the classname ['.$RecordClassname.']');
}
}
/**
* Set the taggedClass property to the name of the tagged class when building relations
* to the TagObject record.
*
* @param string $taggedClass
*
* @since 1.0
*/
public function setTaggedClass($taggedClass)
{
$this->taggedClass = $taggedClass;
}
}