[RTM] Improve model registry

system/modules/core/dca/tl_files.php

@@ -146,7 +146,8 @@
 		),
 		'path' => array
 		(
-			'sql'                     => "varchar(1022) NOT NULL default ''"
+			'eval'                    => array('unique'=>true),
+			'sql'                     => "varchar(1022) NOT NULL default ''",
 		),
 		'extension' => array
 		(

system/modules/core/library/Contao/DcaExtractor.php

@@ -68,6 +68,12 @@ class DcaExtractor extends \Controller
 	 */
 	protected $arrOrderFields = array();
 
+	/**
+	 * Unique fields
+	 * @var array
+	 */
+	protected $arrUniqueFields = array();
+
 	/**
 	 * Keys
 	 * @var array
@@ -208,6 +214,28 @@ public function hasOrderFields()
 	}
 
 
+	/**
+	 * Return an array of unique columns
+	 *
+	 * @return array
+	 */
+	public function getUniqueFields()
+	{
+		return $this->arrUniqueFields;
+	}
+
+
+	/**
+	 * Return true if there are unique fields
+	 *
+	 * @return boolean True if there are unique fields
+	 */
+	public function hasUniqueFields()
+	{
+		return !empty($this->arrUniqueFields);
+	}
+
+
 	/**
 	 * Return the keys as array
 	 *
@@ -468,6 +496,11 @@ protected function createExtract()
 				{
 					$this->arrOrderFields[] = $config['eval']['orderField'];
 				}
+
+				if (isset($config['eval']['unique']) && $config['eval']['unique'] === true)
+				{
+					$this->arrUniqueFields[] = $field;
+				}
 			}
 		}
 
@@ -479,6 +512,11 @@ protected function createExtract()
 			foreach ($sql['keys'] as $field=>$type)
 			{
 				$this->arrKeys[$field] = $type;
+
+				if ($type == 'unique')
+				{
+					$this->arrUniqueFields[] = $field;
+				}
 			}
 		}
 
@@ -498,6 +536,7 @@ protected function createExtract()
 			}
 		}
 
+		$this->arrUniqueFields = array_unique($this->arrUniqueFields);
 		$this->blnIsDbTable = true;
 	}
 }

system/modules/core/library/Contao/Model.php

@@ -65,6 +65,12 @@ abstract class Model
 	 */
 	protected static $strPk = 'id';
 
+	/**
+	 * Class name cache
+	 * @var array
+	 */
+	protected static $arrClassNames = array();
+
 	/**
 	 * Data
 	 * @var array
@@ -257,6 +263,25 @@ public static function getPk()
 	}
 
 
+	/**
+	 * Return an array of unique field/column names
+	 * Do not include the PK here as this is handled separately
+	 *
+	 * @return array
+	 */
+	public static function getUniqueFields()
+	{
+		$objDca = \DcaExtractor::getInstance(static::getTable());
+
+		if ($objDca->hasUniqueFields())
+		{
+			return $objDca->getUniqueFields();
+		}
+
+		return array();
+	}
+
+
 	/**
 	 * Return the name of the related table
 	 *
@@ -677,6 +702,44 @@ public function attach()
 	}
 
 
+	/**
+	 * Called when the model is attached/registered to the model registry
+	 *
+	 * @param \Model\Registry
+	 */
+	public function onRegister(\Model\Registry $registry)
+	{
+		// Register aliases to unique fields
+		foreach (static::getUniqueFields() as $strColumn)
+		{
+			$varAliasValue = $this->{$strColumn};
+			if (!$registry->isAliasRegistered($this, $strColumn, $varAliasValue))
+			{
+				$registry->registerAlias($this, $strColumn, $varAliasValue);
+			}
+		}
+	}
+
+
+	/**
+	 * Called when the model is detached/unregistered from the model registry
+	 *
+	 * @param \Model\Registry
+	 */
+	public function onUnregister(\Model\Registry $registry)
+	{
+		// Unregister aliases to unique fields
+		foreach (static::getUniqueFields() as $strColumn)
+		{
+			$varAliasValue = $this->{$strColumn};
+			if ($registry->isAliasRegistered($this, $strColumn, $varAliasValue))
+			{
+				$registry->unregisterAlias($this, $strColumn, $varAliasValue);
+			}
+		}
+	}
+
+
 	/**
 	 * Prevent saving the model
 	 *
@@ -846,23 +909,6 @@ public static function findMultipleByIds($arrIds, array $arrOptions=array())
 	 */
 	public static function findOneBy($strColumn, $varValue, array $arrOptions=array())
 	{
-		// Try to load from the registry
-		if (empty($arrOptions))
-		{
-			$arrColumn = (array) $strColumn;
-
-			if (count($arrColumn) == 1 && $arrColumn[0] == static::$strPk)
-			{
-				$intId = is_array($varValue) ? $varValue[0] : $varValue;
-				$objModel = \Model\Registry::getInstance()->fetch(static::$strTable, $intId);
-
-				if ($objModel !== null)
-				{
-					return $objModel;
-				}
-			}
-		}
-
 		$arrOptions = array_merge
 		(
 			array
@@ -891,13 +937,22 @@ public static function findOneBy($strColumn, $varValue, array $arrOptions=array(
 	 */
 	public static function findBy($strColumn, $varValue, array $arrOptions=array())
 	{
+		$blnModel = false;
+
+		$arrColumn = (array) $strColumn;
+
+		if (count($arrColumn) == 1 && ($arrColumn[0] === static::getPk() || in_array($arrColumn[0], static::getUniqueFields())))
+		{
+			$blnModel = true;
+		}
+
 		$arrOptions = array_merge
 		(
 			array
 			(
 				'column' => $strColumn,
 				'value'  => $varValue,
-				'return' => 'Collection'
+				'return' => $blnModel ? 'Model' : 'Collection'
 			),
 
 			$arrOptions
@@ -988,6 +1043,25 @@ protected static function find(array $arrOptions)
 			return null;
 		}
 
+		if ($arrOptions['return'] === 'Model')
+		{
+			$arrColumn = (array) $arrOptions['column'];
+
+			if (count($arrColumn) == 1)
+			{
+				if ($arrColumn[0] == static::$strPk || in_array($arrColumn[0], static::getUniqueFields()))
+				{
+					$intId = is_array($arrOptions['value']) ? $arrOptions['value'][0] : $arrOptions['value'];
+					$objModel = \Model\Registry::getInstance()->fetch(static::$strTable, $intId, $arrColumn[0]);
+
+					if ($objModel !== null)
+					{
+						return $objModel;
+					}
+				}
+			}
+		}
+
 		$arrOptions['table'] = static::$strTable;
 		$strQuery = static::buildFindQuery($arrOptions);
 
@@ -1121,9 +1195,15 @@ public static function countAll()
 	 */
 	public static function getClassFromTable($strTable)
 	{
+		if (isset(static::$arrClassNames[$strTable]))
+		{
+			return static::$arrClassNames[$strTable];
+		}
+
 		if (isset($GLOBALS['TL_MODELS'][$strTable]))
 		{
-			return $GLOBALS['TL_MODELS'][$strTable]; // see 4796
+			static::$arrClassNames[$strTable] = $GLOBALS['TL_MODELS'][$strTable]; // see 4796
+			return static::$arrClassNames[$strTable];
 		}
 		else
 		{
@@ -1134,7 +1214,8 @@ public static function getClassFromTable($strTable)
 				array_shift($arrChunks);
 			}
 
-			return implode('', array_map('ucfirst', $arrChunks)) . 'Model';
+			static::$arrClassNames[$strTable] = implode('', array_map('ucfirst', $arrChunks)) . 'Model';
+			return static::$arrClassNames[$strTable];
 		}
 	}