<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Datasource;
use Cake\Datasource\Exception\MissingModelException;
use UnexpectedValueException;
/**
* Provides functionality for loading table classes
* and other repositories onto properties of the host object.
*
* Example users of this trait are Cake\Controller\Controller and
* Cake\Console\Shell.
*/
trait ModelAwareTrait
{
/**
* This object's primary model class name. Should be a plural form.
* CakePHP will not inflect the name.
*
* Example: For an object named 'Comments', the modelClass would be 'Comments'.
* Plugin classes should use `Plugin.Comments` style names to correctly load
* models from the correct plugin.
*
* @var string
*/
public $modelClass;
/**
* A list of overridden model factory functions.
*
* @var array
*/
protected $_modelFactories = [];
/**
* The model type to use.
*
* @var string
*/
protected $_modelType = 'Table';
/**
* Set the modelClass and modelKey properties based on conventions.
*
* If the properties are already set they will not be overwritten
*
* @param string $name Class name.
* @return void
*/
protected function _setModelClass($name)
{
if (empty($this->modelClass)) {
$this->modelClass = $name;
}
}
/**
* Loads and constructs repository objects required by this object
*
* Typically used to load ORM Table objects as required. Can
* also be used to load other types of repository objects your application uses.
*
* If a repository provider does not return an object a MissingModelException will
* be thrown.
*
* @param string|null $modelClass Name of model class to load. Defaults to $this->modelClass
* @param string|null $modelType The type of repository to load. Defaults to the modelType() value.
* @return \Cake\Datasource\RepositoryInterface The model instance created.
* @throws \Cake\Datasource\Exception\MissingModelException If the model class cannot be found.
* @throws \InvalidArgumentException When using a type that has not been registered.
* @throws \UnexpectedValueException If no model type has been defined
*/
public function loadModel($modelClass = null, $modelType = null)
{
if ($modelClass === null) {
$modelClass = $this->modelClass;
}
if ($modelType === null) {
$modelType = $this->getModelType();
if ($modelType === null) {
throw new UnexpectedValueException('No model type has been defined');
}
}
list(, $alias) = pluginSplit($modelClass, true);
if (isset($this->{$alias})) {
return $this->{$alias};
}
if (isset($this->_modelFactories[$modelType])) {
$factory = $this->_modelFactories[$modelType];
}
if (!isset($factory)) {
$factory = FactoryLocator::get($modelType);
}
$this->{$alias} = $factory($modelClass);
if (!$this->{$alias}) {
throw new MissingModelException([$modelClass, $modelType]);
}
return $this->{$alias};
}
/**
* Override a existing callable to generate repositories of a given type.
*
* @param string $type The name of the repository type the factory function is for.
* @param callable $factory The factory function used to create instances.
* @return void
*/
public function modelFactory($type, callable $factory)
{
$this->_modelFactories[$type] = $factory;
}
/**
* Get the model type to be used by this class
*
* @return string
*/
public function getModelType()
{
return $this->_modelType;
}
/**
* Set the model type to be used by this class
*
* @param string $modelType The model type
*
* @return $this
*/
public function setModelType($modelType)
{
$this->_modelType = $modelType;
return $this;
}
/**
* Set or get the model type to be used by this class
*
* @deprecated 3.5.0 Use getModelType()/setModelType() instead.
* @param string|null $modelType The model type or null to retrieve the current
*
* @return string|$this
*/
public function modelType($modelType = null)
{
deprecationWarning(
get_called_class() . '::modelType() is deprecated. ' .
'Use setModelType()/getModelType() instead.'
);
if ($modelType === null) {
return $this->_modelType;
}
$this->_modelType = $modelType;
return $this;
}
}