primo commit

libraries/fof40/Factory/Magic/BaseFactory.php

@@ -0,0 +1,55 @@
+<?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\Container\Container;
+
+abstract class BaseFactory
+{
+	/**
+	 * @var   Container|null  The container where this factory belongs to
+	 */
+	protected $container;
+
+	/**
+	 * Section used to build the namespace prefix. We have to pass it since in CLI we need
+	 * to force the section we're in (ie Site or Admin). {@see \FOF40\Container\Container::getNamespacePrefix() } for
+	 * valid values
+	 *
+	 * @var   string
+	 */
+	protected $section = 'auto';
+
+	/**
+	 * Public constructor
+	 *
+	 * @param   Container  $container  The container we belong to
+	 */
+	public function __construct(Container $container)
+	{
+		$this->container = $container;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getSection(): string
+	{
+		return $this->section;
+	}
+
+	/**
+	 * @param   string  $section
+	 */
+	public function setSection(string $section): void
+	{
+		$this->section = $section;
+	}
+}

libraries/fof40/Factory/Magic/ControllerFactory.php

@@ -0,0 +1,76 @@
+<?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\Controller\DataController;
+use FOF40\Factory\Exception\ControllerNotFound;
+
+/**
+ * Creates a DataController object instance based on the information provided by the fof.xml configuration file
+ */
+class ControllerFactory 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  DataController  A new DataController object
+	 */
+	public function make(string $name = null, array $config = []): DataController
+	{
+		if (empty($name))
+		{
+			throw new ControllerNotFound($name);
+		}
+
+		$appConfig = $this->container->appConfig;
+		$name      = ucfirst($name);
+
+		$defaultConfig = [
+			'name'           => $name,
+			'default_task'   => $appConfig->get("views.$name.config.default_task", 'main'),
+			'autoRouting'    => $appConfig->get("views.$name.config.autoRouting", 1),
+			'csrfProtection' => $appConfig->get("views.$name.config.csrfProtection", 2),
+			'viewName'       => $appConfig->get("views.$name.config.viewName", null),
+			'modelName'      => $appConfig->get("views.$name.config.modelName", null),
+			'taskPrivileges' => $appConfig->get("views.$name.acl"),
+			'cacheableTasks' => $appConfig->get("views.$name.config.cacheableTasks", [
+				'browse',
+				'read',
+			]),
+			'taskMap'        => $appConfig->get("views.$name.taskmap"),
+		];
+
+		$config = array_merge($defaultConfig, $config);
+
+		$className = $this->container->getNamespacePrefix($this->getSection()) . 'Controller\\DefaultDataController';
+
+		if (!class_exists($className, true))
+		{
+			$className = 'FOF40\\Controller\\DataController';
+		}
+
+		$controller = new $className($this->container, $config);
+
+		$taskMap = $config['taskMap'];
+
+		if (is_array($taskMap) && !empty($taskMap))
+		{
+			foreach ($taskMap as $virtualTask => $method)
+			{
+				$controller->registerTask($virtualTask, $method);
+			}
+		}
+
+		return $controller;
+	}
+}

libraries/fof40/Factory/Magic/DispatcherFactory.php

@@ -0,0 +1,41 @@
+<?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\Dispatcher\Dispatcher;
+
+/**
+ * Creates a Dispatcher object instance based on the information provided by the fof.xml configuration file
+ */
+class DispatcherFactory extends BaseFactory
+{
+	/**
+	 * Create a new object instance
+	 *
+	 * @param   array  $config  The config parameters which override the fof.xml information
+	 *
+	 * @return  Dispatcher  A new Dispatcher object
+	 */
+	public function make(array $config = []): Dispatcher
+	{
+		$appConfig     = $this->container->appConfig;
+		$defaultConfig = $appConfig->get('dispatcher.*');
+		$config        = array_merge($defaultConfig, $config);
+
+		$className = $this->container->getNamespacePrefix($this->getSection()) . 'Dispatcher\\DefaultDispatcher';
+
+		if (!class_exists($className, true))
+		{
+			$className = '\\FOF40\\Dispatcher\\Dispatcher';
+		}
+
+		return new $className($this->container, $config);
+	}
+}

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;
+	}
+}

libraries/fof40/Factory/Magic/TransparentAuthenticationFactory.php

@@ -0,0 +1,42 @@
+<?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\TransparentAuthentication\TransparentAuthentication;
+
+/**
+ * Creates a TransparentAuthentication object instance based on the information provided by the fof.xml configuration
+ * file
+ */
+class TransparentAuthenticationFactory extends BaseFactory
+{
+	/**
+	 * Create a new object instance
+	 *
+	 * @param   array  $config  The config parameters which override the fof.xml information
+	 *
+	 * @return  TransparentAuthentication  A new TransparentAuthentication object
+	 */
+	public function make(array $config = []): TransparentAuthentication
+	{
+		$appConfig     = $this->container->appConfig;
+		$defaultConfig = $appConfig->get('authentication.*');
+		$config        = array_merge($defaultConfig, $config);
+
+		$className = $this->container->getNamespacePrefix($this->getSection()) . 'TransparentAuthentication\\DefaultTransparentAuthentication';
+
+		if (!class_exists($className, true))
+		{
+			$className = '\\FOF40\\TransparentAuthentication\\TransparentAuthentication';
+		}
+
+		return new $className($this->container, $config);
+	}
+}

libraries/fof40/Factory/Magic/ViewFactory.php

@@ -0,0 +1,68 @@
+<?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\ViewNotFound;
+use FOF40\View\View;
+
+/**
+ * Creates a DataModel/TreeModel object instance based on the information provided by the fof.xml configuration file
+ */
+class ViewFactory extends BaseFactory
+{
+	/**
+	 * Create a new object instance
+	 *
+	 * @param   string  $name      The name of the class we're making
+	 * @param   string  $viewType  The view type, default html, possible values html, form, raw, json, csv
+	 * @param   array   $config    The config parameters which override the fof.xml information
+	 *
+	 * @return  View  A DataViewInterface view
+	 */
+	public function make(string $name = null, string $viewType = 'html', array $config = []): View
+	{
+		if (empty($name))
+		{
+			throw new ViewNotFound("[name : type] = [$name : $viewType]");
+		}
+
+		$appConfig = $this->container->appConfig;
+		$name      = ucfirst($name);
+
+		$defaultConfig = [
+			'name'          => $name,
+			'template_path' => $appConfig->get("views.$name.config.template_path"),
+			'layout'        => $appConfig->get("views.$name.config.layout"),
+			// You can pass something like .php => Class1, .foo.bar => Class 2
+			'viewEngineMap' => $appConfig->get("views.$name.config.viewEngineMap"),
+		];
+
+		$config = array_merge($defaultConfig, $config);
+
+		$className = $this->container->getNamespacePrefix($this->getSection()) . 'View\\DataView\\Default' . ucfirst($viewType);
+
+		if (!class_exists($className, true))
+		{
+			$className = '\\FOF40\\View\\DataView\\' . ucfirst($viewType);
+		}
+
+		if (!class_exists($className, true))
+		{
+			$className = $this->container->getNamespacePrefix($this->getSection()) . 'View\\DataView\\DefaultHtml';
+		}
+
+		if (!class_exists($className))
+		{
+			$className = '\\FOF40\\View\\DataView\\Html';
+		}
+
+		return new $className($this->container, $config);
+	}
+}