Maslosoft Mangan API
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 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Traits;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Interfaces\OwneredInterface;
/**
* This trait provides basic implemention on ownering of documents. This allows
* sub-document to get it's parent or root document.
*
* When using this trait, it is recommended that all classes in composition to
* implement `OwneredInterface` or use this trait.
*
* **NOTE:** Currently it's implementation does **not work instantly**. Owner is
* set when transforming objects, which include save/load.
*
* @see OwneredInterface
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
trait OwneredTrait
{
/**
* Owner reference or null if it's root object
* @var AnnotatedInterface|null
*/
private $_owner = null;
/**
* Get document owner.
*
* This might return `null` if there is no owner.
*
* @return AnnotatedInterface Owner
* @Ignored
*/
public function getOwner()
{
return $this->_owner;
}
/**
* Get document root. This will traverse through objects
* hierarchy, untill owner-less document is found.
*
* This might return same object instance if there is no owner.
*
* The return value is *guaranteed* to be document instance.
*
*
*
* @return AnnotatedInterface Root document
* @Ignored
*/
public function getRoot()
{
if ($this->_owner instanceof OwneredInterface && $this->_owner !== null)
{
return $this->_owner->getRoot();
}
else
{
return $this;
}
}
/**
* Set class owner
*
* @param AnnotatedInterface|null $owner
* @Ignored
*/
public function setOwner(AnnotatedInterface $owner = null)
{
$this->_owner = $owner;
}
}
API documentation generated by ApiGen