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
<?php
namespace Alpha\Util\Graph;
use Alpha\Exception\IllegalArguementException;
/**
* Maintains the geometry for a tree node.
*
* @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 GraphNode
{
/**
* The id of the node.
*
* @var int
*
* @since 1.0
*/
private $id = 0;
/**
* The height of the node.
*
* @var int
*
* @since 1.0
*/
private $height = 0;
/**
* The width of the node.
*
* @var int
*
* @since 1.0
*/
private $width = 0;
/**
* The x position of the node.
*
* @var int
*
* @since 1.0
*/
private $x = 0;
/**
* The y position of the node.
*
* @var int
*
* @since 1.0
*/
private $y = 0;
/**
* The node to the left of this one.
*
* @var Alpha\Util\Graph\GraphNode
*
* @since 1.0
*/
private $leftNode;
/**
* The node to the right of this one.
*
* @var Alpha\Util\Graph\GraphNode
*
* @since 1.0
*/
private $rightNode;
/**
* An array of child nodes of this node.
*
* @var array
*
* @since 1.0
*/
private $children = array();
/**
* The margin offset of the current node.
*
* @var int
*
* @since 1.0
*/
private $offset = 0;
/**
* Optional positional modifier.
*
* @var int
*
* @since 1.0
*/
private $modifier = 0;
/**
* Parent node of this node (if any).
*
* @var Alpha\Util\Graph\GraphNode
*
* @since 1.0
*/
private $parentNode;
/**
* The text message to display on the node.
*
* @var string
*
* @since 1.0
*/
private $message;
/**
* A 2D array of the coordinates of the endpoints for connectots on this node.
*
* @var array
*
* @since 1.0
*/
private $links = array();
/**
* An array containing the R,G,B values for the colour of this node.
*
* @var array
*
* @since 1.0
*/
private $nodeColour = array();
/**
* If the node is clickable in an image map, use this property to hold the target URL.
*
* @var string
*
* @since 1.0
*/
private $URL;
/**
* Constructor.
*
* @param int $id
* @param int $width
* @param int $height
* @param string $message
* @param array $nodeColour
* @param string $URL
*/
public function __construct($id, $width, $height, $message = '', $nodeColour = array(), $URL = null)
{
$this->id = $id;
$this->width = $width;
$this->height = $height;
$this->message = $message;
$this->nodeColour = $nodeColour;
$this->URL = $URL;
}
/**
* Get the node colour array.
*
* @return array
*
* @since 1.0
*/
public function getNodeColour()
{
return $this->nodeColour;
}
/**
* Set the node colour array.
*
* @param array $nodeColour
*
* @throws Alpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function setNodeColour($nodeColour)
{
if (is_array($nodeColour) && count($nodeColour) == 3) {
$this->nodeColour = $nodeColour;
} else {
throw new IllegalArguementException('The nodeColour value passed ['.$nodeColour.'] is not a valid array!');
}
}
/**
* Get the node URL.
*
* @return string
*
* @since 1.0
*/
public function getURL()
{
return $this->URL;
}
/**
* Set the node URL.
*
* @param string $URL
*
* @since 1.0
*/
public function setURL($URL)
{
$this->URL = $URL;
}
/**
* Get the node text message.
*
* @return string
*
* @since 1.0
*/
public function getMessage()
{
return $this->message;
}
/**
* Set the node text message.
*
* @param string $message
*
* @since 1.0
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* Get the node offset.
*
* @return integer
*
* @since 1.0
*/
public function getOffset()
{
return $this->offset;
}
/**
* Set the node offset.
*
* @param int $offset
*
* @since 1.0
*/
public function setOffset($offset)
{
$this->offset = $offset;
}
/**
* Get the node modifier.
*
* @return int
*
* @since 1.0
*/
public function getModifier()
{
return $this->modifier;
}
/**
* Set the node modifier.
*
* @param int $modifier
*
* @since 1.0
*/
public function setModifier($modifier)
{
$this->modifier = $modifier;
}
/**
* Get the number of child nodes attached to this node.
*
* @return int
*
* @since 1.0
*/
public function childCount()
{
return count($this->children);
}
/**
* Get the parent node of this node (if any).
*
* @return Alpha\Util\Graph\GraphNode
*
* @since 1.0
*/
public function getParentNode()
{
return $this->parentNode;
}
/**
* Set the parent node.
*
* @param Alpha\Util\Graph\GraphNode $node
*
* @throws Alpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function setParentNode($node)
{
if ($node instanceof self) {
$this->parentNode = $node;
} else {
throw new IllegalArguementException('The node object passed to setParentNode is not a valid GraphNode instance!');
}
}
/**
* Get the node to the left of this one (if any).
*
* @return Alpha\Util\Graph\GraphNode
*
* @since 1.0
*/
public function getLeftSibling()
{
if ($this->leftNode) {
return $this->leftNode;
} else {
return;
}
}
/**
* Sets the node to the left of this node.
*
* @param Alpha\Util\Graph\GraphNode $node
*
* @throws Alpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function setLeftSibling($node)
{
if ($node instanceof self) {
$this->leftNode = $node;
} else {
throw new IllegalArguementException('The node object passed to setLeftSibling is not a valid GraphNode instance!');
}
}
/**
* Get the node to the right of this one (if any).
*
* @return Alpha\Util\Graph\GraphNode
*
* @since 1.0
*/
public function getRightSibling()
{
if ($this->rightNode) {
return $this->rightNode;
} else {
return;
}
}
/**
* Sets the node to the right of this node.
*
* @param Alpha\Util\Graph\GraphNode $node
*
* @throws Alpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function setRightSibling($node)
{
if ($node instanceof self) {
$this->rightNode = $node;
} else {
throw new IllegalArguementException('The node object passed to setRightSibling is not a valid GraphNode instance!');
}
}
/**
* Gets the child node at the index provided, or returns false if none is found.
*
* @param int $i
*
* @return mixed
*
* @since 1.0
*/
public function getChildAt($i)
{
if (isset($this->children[$i])) {
return $this->children[$i];
} else {
return false;
}
}
/**
* Calculates and returns the midpoint X coordinate of the children of this node.
*
* @return double
*
* @since 1.0
*/
public function getChildrenCenter()
{
$node = $this->getChildAt(0);
$node1 = $this->getChildAt(count($this->children)-1);
return $node->getOffset()+(($node1->getOffset()-$node->getOffset())+$node1->getWidth())/2;
}
/**
* Returns the array of child GraphNode objects.
*
* @return array
*
* @since 1.0
*/
public function getChildren()
{
return $this->children;
}
/**
* Add a new node to the children array of this node.
*
* @param GraphNode $node
*
* @throws ALpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function addChild($node)
{
if ($node instanceof self) {
array_push($this->children, $node);
} else {
throw new IllegalArguementException('The node object passed to addChild is not a valid GraphNode instance!');
}
}
/**
* Returns the links array.
*
* @return array
*
* @since 1.0
*/
public function getLinks()
{
return $this->links;
}
/**
* Sets up the array of connector endpoints.
*
* @since 1.0
*/
public function setUpLinks()
{
$xa = $this->x+($this->width/2);
$ya = $this->y+$this->height;
foreach ($this->children as $child) {
$xd = $xc = $child->getX()+($child->getWidth()/2);
$yd = $child->getY();
$xb = $xa;
$yb = $yc = $ya+($yd-$ya)/2;
$this->links[$child->id]['xa'] = $xa;
$this->links[$child->id]['ya'] = $ya;
$this->links[$child->id]['xb'] = $xb;
$this->links[$child->id]['yb'] = $yb;
$this->links[$child->id]['xc'] = $xc;
$this->links[$child->id]['yc'] = $yc;
$this->links[$child->id]['xd'] = $xd;
$this->links[$child->id]['yd'] = $yd;
}
}
/**
* Returns the node height.
*
* @return int
*
* @since 1.0
*/
public function getHeight()
{
return $this->height;
}
/**
* Returns the node width.
*
* @return int
*
* @since 1.0
*/
public function getWidth()
{
return $this->width;
}
/**
* Returns the node X-coordinate.
*
* @return int
*
* @since 1.0
*/
public function getX()
{
return $this->x;
}
/**
* Returns the node Y-coordinate.
*
* @return int
*
* @since 1.0
*/
public function getY()
{
return $this->y;
}
/**
* Sets the node X-coordinate.
*
* @param int $x
*
* @since 1.0
*/
public function setX($x)
{
$this->x = $x;
}
/**
* Sets the node Y-coordinate.
*
* @param int $y
*
* @since 1.0
*/
public function setY($y)
{
$this->y = $y;
}
}