primo commit

libraries/fof40/Factory/Magic/ModelFactory.php

@@ -0,0 +1,86 @@
+<?php
+/**
+ * @package   FOF
+ * @copyright Copyright (c)2010-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace FOF40\Factory\Magic;
+
+defined('_JEXEC') || die;
+
+use FOF40\Factory\Exception\ModelNotFound;
+use FOF40\Model\DataModel;
+use FOF40\Model\TreeModel;
+
+/**
+ * Creates a DataModel/TreeModel object instance based on the information provided by the fof.xml configuration file
+ */
+class ModelFactory extends BaseFactory
+{
+	/**
+	 * Create a new object instance
+	 *
+	 * @param string $name   The name of the class we're making
+	 * @param array  $config The config parameters which override the fof.xml information
+	 *
+	 * @return  TreeModel|DataModel  A new TreeModel or DataModel object
+	 */
+	public function make(string $name = null, array $config = []): DataModel
+	{
+		if (empty($name))
+		{
+			throw new ModelNotFound($name);
+		}
+
+		$appConfig = $this->container->appConfig;
+		$name      = ucfirst($name);
+
+		$defaultConfig = [
+			'name'             => $name,
+			'use_populate'     => $appConfig->get("models.$name.config.use_populate"),
+			'ignore_request'   => $appConfig->get("models.$name.config.ignore_request"),
+			'tableName'        => $appConfig->get("models.$name.config.tbl"),
+			'idFieldName'      => $appConfig->get("models.$name.config.tbl_key"),
+			'knownFields'      => $appConfig->get("models.$name.config.knownFields", null),
+			'autoChecks'       => $appConfig->get("models.$name.config.autoChecks"),
+			'contentType'      => $appConfig->get("models.$name.config.contentType"),
+			'fieldsSkipChecks' => $appConfig->get("models.$name.config.fieldsSkipChecks", []),
+			'aliasFields'      => $appConfig->get("models.$name.field", []),
+			'behaviours'       => $appConfig->get("models.$name.behaviors", []),
+			'fillable_fields'  => $appConfig->get("models.$name.config.fillable_fields", []),
+			'guarded_fields'   => $appConfig->get("models.$name.config.guarded_fields", []),
+			'relations'        => $appConfig->get("models.$name.relations", []),
+		];
+
+		$config = array_merge($defaultConfig, $config);
+
+		// Get the default class names
+		$dataModelClassName = $this->container->getNamespacePrefix($this->getSection()) . 'Model\\DefaultDataModel';
+
+		if (!class_exists($dataModelClassName, true))
+		{
+			$dataModelClassName = '\\FOF40\\Model\\DataModel';
+		}
+
+		$treeModelClassName = $this->container->getNamespacePrefix($this->getSection()) . 'Model\\DefaultTreeModel';
+
+		if (!class_exists($treeModelClassName, true))
+		{
+			$treeModelClassName = '\\FOF40\\Model\\TreeModel';
+		}
+
+		try
+		{
+			// First try creating a TreeModel
+			$model = new $treeModelClassName($this->container, $config);
+		}
+		catch (DataModel\Exception\TreeIncompatibleTable $e)
+		{
+			// If the table isn't a nested set, create a regular DataModel
+			$model = new $dataModelClassName($this->container, $config);
+		}
+
+		return $model;
+	}
+}