Stable release of v4.0.0-alpha1

First alpha release of Component Builder towards Joomla 4 (very unstable...).

admin/src/Rule/CodeRule.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * @package    Joomla.Component.Builder
+ *
+ * @created    30th April, 2015
+ * @author     Llewellyn van der Merwe <https://dev.vdm.io>
+ * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
+ * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+namespace VDM\Component\Componentbuilder\Administrator\Rule;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Form\Form;
+use Joomla\CMS\Form\FormRule;
+use Joomla\Registry\Registry;
+use Joomla\CMS\HTML\HTMLHelper as Html;
+use Joomla\CMS\Component\ComponentHelper;
+use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
+
+// No direct access to this file
+\defined('JPATH_PLATFORM') or die;
+
+/**
+ * Form Rule (Code) class for the Joomla Platform.
+ *
+ * @since  3.5
+ */
+class CodeRule extends FormRule
+{
+	/**
+	 * Method to test the value.
+	 *
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
+	 * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
+	 * @param   Form               $form     The form object for which the field is being tested.
+	 *
+	 * @return  boolean  True if the value is valid, false otherwise.
+	 */
+	public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
+	{
+		// This removes all validation (is dangerous) but needed to submit code via JCB
+		return true;
+
+		/**
+		 * My idea is to add some kind of validation to improve JCB code (per/language)
+		 *
+		 * So at this time this code validation is used for JavaScript,CSS,HTML and PHP.
+		 * We can see what language is being worked on with the syntax property in the $element. (in JCB)
+		 * What complicates things is the placeholders, of both custom code, component, and view names.
+		 * Ideally we could strip them and then validate the code to being syntactically correct.
+		 * But since some of the placeholders form part of the class/function names and the more, it seems like we are pressed for a much more advance solution.
+		 * If you have any ideas to how we can go about to do this, then please open an issue on github and lets begin. (this is a nice to have, so don't break a leg...)
+		 */
+	}
+}

admin/src/Rule/GuidRule.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * @package    Joomla.Component.Builder
+ *
+ * @created    30th April, 2015
+ * @author     Llewellyn van der Merwe <https://dev.vdm.io>
+ * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
+ * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+namespace VDM\Component\Componentbuilder\Administrator\Rule;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Form\Form;
+use Joomla\CMS\Form\FormRule;
+use Joomla\Registry\Registry;
+use Joomla\CMS\HTML\HTMLHelper as Html;
+use Joomla\CMS\Component\ComponentHelper;
+use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
+
+// No direct access to this file
+\defined('JPATH_PLATFORM') or die;
+
+/**
+ * Form Rule (Guid) class for the Joomla Platform.
+ *
+ * @since  3.5
+ */
+class GuidRule extends FormRule
+{
+	/**
+	 * Method to test for a Globally Unique Identifier.
+	 *
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
+	 * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
+	 * @param   Form               $form     The form object for which the field is being tested.
+	 *
+	 * @return  boolean  True if the value is valid, false otherwise.
+	 *
+	 */
+	public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
+	{
+		$value = trim($value);
+
+		// If the field is empty and not required, the field is valid.
+		$required = ((string) $element['required'] == 'true' || (string) $element['required'] == 'required');
+
+		if (!$required && empty($value))
+		{
+			return true;
+		}
+
+		// thanks to Lewie https://stackoverflow.com/a/1515456/1429677
+		return preg_match("/^(\{)?[a-f\d]{8}(-[a-f\d]{4}){4}[a-f\d]{8}(?(1)\})$/i", $value);
+	}
+
+}

admin/src/Rule/IntRule.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * @package    Joomla.Component.Builder
+ *
+ * @created    30th April, 2015
+ * @author     Llewellyn van der Merwe <https://dev.vdm.io>
+ * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
+ * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+namespace VDM\Component\Componentbuilder\Administrator\Rule;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Form\Form;
+use Joomla\CMS\Form\FormRule;
+use Joomla\Registry\Registry;
+use Joomla\CMS\HTML\HTMLHelper as Html;
+use Joomla\CMS\Component\ComponentHelper;
+use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
+
+// No direct access to this file
+\defined('JPATH_PLATFORM') or die;
+
+/**
+ * Form Rule (Int) class for the Joomla Platform.
+ *
+ * @since  3.5
+ */
+class IntRule extends FormRule
+{
+	/**
+	 * Method to test that an integer value was added.
+	 *
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
+	 * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
+	 * @param   Form               $form     The form object for which the field is being tested.
+	 *
+	 * @return  boolean  True if the value is valid integer, false otherwise.
+	 *
+	 */
+	public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
+	{
+		// Check if the field is required.
+		$required = ((string) $element['required'] == 'true' || (string) $element['required'] == 'required');
+
+		// If the value is empty and the field is not required return True.
+		if (($value === '' || $value === null) && ! $required)
+		{
+			return true;
+		}
+
+		// now validate the value to be an integer
+		// we need to validate a string with the integer in it
+		// since this is how Joomla passes the value to the test method
+		// so we use type coercion along with is_numeric
+		return is_numeric($value) && is_int(+$value);
+		// if you have a better idea... lets hear it.
+	}
+}

admin/src/Rule/SourcemapcheckerRule.php

@@ -0,0 +1,143 @@
+<?php
+/**
+ * @package    Joomla.Component.Builder
+ *
+ * @created    30th April, 2015
+ * @author     Llewellyn van der Merwe <https://dev.vdm.io>
+ * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
+ * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+namespace VDM\Component\Componentbuilder\Administrator\Rule;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Form\Form;
+use Joomla\CMS\Form\FormRule;
+use Joomla\Registry\Registry;
+use Joomla\CMS\HTML\HTMLHelper as Html;
+use Joomla\CMS\Component\ComponentHelper;
+use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
+use VDM\Joomla\Utilities\ArrayHelper;
+
+// No direct access to this file
+\defined('JPATH_PLATFORM') or die;
+
+/**
+ * Form Rule (Sourcemapchecker) class for the Joomla Platform.
+ *
+ * @since  3.5
+ */
+class SourcemapcheckerRule extends FormRule
+{
+	/**
+	 * Method to test if the selected source map has all the fields it would need
+	 *
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
+	 * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
+	 * @param   Form               $form     The form object for which the field is being tested.
+	 *
+	 * @return  boolean  True if the value is valid, false otherwise.
+	 *
+	 * @since   3.10.12
+	 */
+	public function test(\SimpleXMLElement $element, $value, $group = null, ?Registry $input = null, ?Form $form = null)
+	{
+		$fields = $this->getSelectedFields($value);
+
+		$status = true;
+
+		if ($fields === [])
+		{
+			// no fields selected (not good)
+			$missing = Text::_('COM_COMPONENTBUILDER_NO_FIELDS_WHERE_SELECTED');
+			$status = false;
+		}
+		// we only test if we have a table name
+		elseif (($table = $input->get('table')) !== null)
+		{
+			// the fields to ignore Since 3.2
+			$ignore = [
+				'checked_out_time',
+				'checked_out',
+				'modified',
+				'created',
+				'modified_by',
+				'created_by'
+			];
+
+			// get the database object.
+			$db = Factory::getDbo();
+
+			$columnDetails = $db->getTableColumns('#__' . $table, false);
+			$requiredColumns = [];
+
+			foreach ($columnDetails as $column => $details)
+			{
+				if (in_array($column, $ignore))
+				{
+					continue;
+				}
+
+				if ($details->Null === 'NO' && ($details->Default === null || strtolower($details->Extra) === 'auto_increment'))
+				{
+					$requiredColumns[] = $column;
+				}
+			}
+
+			$_missing = array_diff($requiredColumns, $fields);
+
+			if (!empty($_missing))
+			{
+				// Format missing fields for better readability
+				$missing = implode(', ', $_missing);
+				$status = false;
+			}
+		}
+
+		// when we fail
+		if (!$status)
+		{
+			Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_REQUIRED_FIELDS_MISSING_IN_THE_BMYSQL_TABLES_SOURCE_MAPB_SELECTIONBR_S', $missing), 'Error');
+		}
+
+		return $status;
+	}
+
+	/**
+	 * Method to get array of fields
+	 *
+	 * @param string|null $value
+	 *
+	 * @return array
+	 * @since  3.2.0
+	 */
+	private function getSelectedFields(?string $value): array
+	{
+		// reset array buckets
+		$fields = [];
+		// the other tables
+		if (is_string($value) && strpos((string) $value, PHP_EOL) !== false)
+		{
+			$lines = explode(PHP_EOL, (string) $value);
+			if (ArrayHelper::check($lines))
+			{
+				foreach ($lines as $field)
+				{
+					if (strpos($field, "=>") !== false)
+					{
+						list($source) = explode(
+							"=>", $field, 2
+						);
+						$fields[] = trim($source);
+					}
+				}
+			}
+		}
+		return $fields;
+	}
+}

admin/src/Rule/UniqueplaceholderRule.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * @package    Joomla.Component.Builder
+ *
+ * @created    30th April, 2015
+ * @author     Llewellyn van der Merwe <https://dev.vdm.io>
+ * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
+ * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+namespace VDM\Component\Componentbuilder\Administrator\Rule;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Form\Form;
+use Joomla\CMS\Form\FormRule;
+use Joomla\Registry\Registry;
+use Joomla\CMS\HTML\HTMLHelper as Html;
+use Joomla\CMS\Component\ComponentHelper;
+use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
+
+// No direct access to this file
+\defined('JPATH_PLATFORM') or die;
+
+/**
+ * Form Rule (Uniqueplaceholder) class for the Joomla Platform.
+ *
+ * @since  3.5
+ */
+class UniqueplaceholderRule extends FormRule
+{
+	/**
+	 * Method to test the field value for uniqueness.
+	 *
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
+	 * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
+	 * @param   Form               $form     The form object for which the field is being tested.
+	 *
+	 * @return  boolean  True if the value is valid, false otherwise.
+	 *
+	 * @since   11.1
+	 */
+	public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
+	{
+		// Get the extra field check attribute.
+		$id = ($input instanceof Registry) ? $input->get('id', null) : null;
+		// now test against all the placeholders and the compiler
+		return ComponentbuilderHelper::validateUniquePlaceholder($id, $value, true);
+	}
+}

admin/src/Rule/index.html

@@ -0,0 +1 @@
+<html><body bgcolor="#FFFFFF"></body></html>