/var/www/vhosts/ihelp.ro/httpdocs/vendor/cakephp/cakephp/src/ORM
Edit: /var/www/vhosts/ihelp.ro/httpdocs/vendor/cakephp/cakephp/src/ORM/EagerLoadable.php (8088B)
*/
protected $_associations = [];
/**
* The Association class instance to use for loading the records.
*
* @var \Cake\ORM\Association|null
*/
protected $_instance;
/**
* A list of options to pass to the association object for loading
* the records.
*
* @var array
*/
protected $_config = [];
/**
* A dotted separated string representing the path of associations
* that should be followed to fetch this level.
*
* @var string
*/
protected $_aliasPath;
/**
* A dotted separated string representing the path of entity properties
* in which results for this level should be placed.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The property path of `country` will be `author.company`
*
* @var string|null
*/
protected $_propertyPath;
/**
* Whether this level can be fetched using a join.
*
* @var bool
*/
protected $_canBeJoined = false;
/**
* Whether this level was meant for a "matching" fetch
* operation
*
* @var bool|null
*/
protected $_forMatching;
/**
* The property name where the association result should be nested
* in the result.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The target property of `country` will be just `country`
*
* @var string|null
*/
protected $_targetProperty;
/**
* Constructor. The $config parameter accepts the following array
* keys:
*
* - associations
* - instance
* - config
* - canBeJoined
* - aliasPath
* - propertyPath
* - forMatching
* - targetProperty
*
* The keys maps to the settable properties in this class.
*
* @param string $name The Association name.
* @param array $config The list of properties to set.
*/
public function __construct(string $name, array $config = [])
{
$this->_name = $name;
$allowed = [
'associations', 'instance', 'config', 'canBeJoined',
'aliasPath', 'propertyPath', 'forMatching', 'targetProperty',
];
foreach ($allowed as $property) {
if (isset($config[$property])) {
$this->{'_' . $property} = $config[$property];
}
}
}
/**
* Adds a new association to be loaded from this level.
*
* @param string $name The association name.
* @param \Cake\ORM\EagerLoadable $association The association to load.
* @return void
*/
public function addAssociation(string $name, EagerLoadable $association): void
{
$this->_associations[$name] = $association;
}
/**
* Returns the Association class instance to use for loading the records.
*
* @return array<\Cake\ORM\EagerLoadable>
*/
public function associations(): array
{
return $this->_associations;
}
/**
* Gets the Association class instance to use for loading the records.
*
* @return \Cake\ORM\Association
* @throws \RuntimeException
*/
public function instance(): Association
{
if ($this->_instance === null) {
throw new \RuntimeException('No instance set.');
}
return $this->_instance;
}
/**
* Gets a dot separated string representing the path of associations
* that should be followed to fetch this level.
*
* @return string
*/
public function aliasPath(): string
{
return $this->_aliasPath;
}
/**
* Gets a dot separated string representing the path of entity properties
* in which results for this level should be placed.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The property path of `country` will be `author.company`
*
* @return string|null
*/
public function propertyPath(): ?string
{
return $this->_propertyPath;
}
/**
* Sets whether this level can be fetched using a join.
*
* @param bool $possible The value to set.
* @return $this
*/
public function setCanBeJoined(bool $possible)
{
$this->_canBeJoined = $possible;
return $this;
}
/**
* Gets whether this level can be fetched using a join.
*
* @return bool
*/
public function canBeJoined(): bool
{
return $this->_canBeJoined;
}
/**
* Sets the list of options to pass to the association object for loading
* the records.
*
* @param array $config The value to set.
* @return $this
*/
public function setConfig(array $config)
{
$this->_config = $config;
return $this;
}
/**
* Gets the list of options to pass to the association object for loading
* the records.
*
* @return array
*/
public function getConfig(): array
{
return $this->_config;
}
/**
* Gets whether this level was meant for a
* "matching" fetch operation.
*
* @return bool|null
*/
public function forMatching(): ?bool
{
return $this->_forMatching;
}
/**
* The property name where the result of this association
* should be nested at the end.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The target property of `country` will be just `country`
*
* @return string|null
*/
public function targetProperty(): ?string
{
return $this->_targetProperty;
}
/**
* Returns a representation of this object that can be passed to
* Cake\ORM\EagerLoader::contain()
*
* @return array
*/
public function asContainArray(): array
{
$associations = [];
foreach ($this->_associations as $assoc) {
$associations += $assoc->asContainArray();
}
$config = $this->_config;
if ($this->_forMatching !== null) {
$config = ['matching' => $this->_forMatching] + $config;
}
return [
$this->_name => [
'associations' => $associations,
'config' => $config,
],
];
}
/**
* Handles cloning eager loadables.
*
* @return void
*/
public function __clone()
{
foreach ($this->_associations as $i => $association) {
$this->_associations[$i] = clone $association;
}
}
}