Added a new convention to how JCB builds field names, so that it does not remove/convert the numbers. gh-427

This commit is contained in:
Llewellyn van der Merwe 2019-06-18 14:38:34 +02:00
parent 8acbb3b3a4
commit 8f8546502a
No known key found for this signature in database
GPG Key ID: CAD7B16D27AF28C5
4 changed files with 56 additions and 9 deletions

View File

@ -146,7 +146,7 @@ TODO
+ *Author*: [Llewellyn van der Merwe](mailto:llewellyn@joomlacomponentbuilder.com) + *Author*: [Llewellyn van der Merwe](mailto:llewellyn@joomlacomponentbuilder.com)
+ *Name*: [Component Builder](https://github.com/vdm-io/Joomla-Component-Builder) + *Name*: [Component Builder](https://github.com/vdm-io/Joomla-Component-Builder)
+ *First Build*: 30th April, 2015 + *First Build*: 30th April, 2015
+ *Last Build*: 17th June, 2019 + *Last Build*: 18th June, 2019
+ *Version*: 2.9.20 + *Version*: 2.9.20
+ *Copyright*: Copyright (C) 2015 - 2019 Vast Development Method. All rights reserved. + *Copyright*: Copyright (C) 2015 - 2019 Vast Development Method. All rights reserved.
+ *License*: GNU General Public License version 2 or later; see LICENSE.txt + *License*: GNU General Public License version 2 or later; see LICENSE.txt

View File

@ -146,7 +146,7 @@ TODO
+ *Author*: [Llewellyn van der Merwe](mailto:llewellyn@joomlacomponentbuilder.com) + *Author*: [Llewellyn van der Merwe](mailto:llewellyn@joomlacomponentbuilder.com)
+ *Name*: [Component Builder](https://github.com/vdm-io/Joomla-Component-Builder) + *Name*: [Component Builder](https://github.com/vdm-io/Joomla-Component-Builder)
+ *First Build*: 30th April, 2015 + *First Build*: 30th April, 2015
+ *Last Build*: 17th June, 2019 + *Last Build*: 18th June, 2019
+ *Version*: 2.9.20 + *Version*: 2.9.20
+ *Copyright*: Copyright (C) 2015 - 2019 Vast Development Method. All rights reserved. + *Copyright*: Copyright (C) 2015 - 2019 Vast Development Method. All rights reserved.
+ *License*: GNU General Public License version 2 or later; see LICENSE.txt + *License*: GNU General Public License version 2 or later; see LICENSE.txt

View File

@ -689,6 +689,13 @@ class Get
*/ */
public $minify = 0; public $minify = 0;
/**
* field name builder switch
*
* @var int
*/
public $fieldNameBuilder = 0;
/** /**
* Is Tidy Enabled * Is Tidy Enabled
* *
@ -750,6 +757,8 @@ class Get
$this->params = JComponentHelper::getParams('com_componentbuilder'); $this->params = JComponentHelper::getParams('com_componentbuilder');
// set the minfy switch of the JavaScript // set the minfy switch of the JavaScript
$this->minify = (isset($config['minify']) && $config['minify'] != 2) ? $config['minify'] : $this->params->get('minify', 0); $this->minify = (isset($config['minify']) && $config['minify'] != 2) ? $config['minify'] : $this->params->get('minify', 0);
// field name builder switch between conventions
$this->fieldNameBuilder = $this->params->get('field_name_builder', 0); // change this to 1 for testing the new convention
// set the global language // set the global language
$this->langTag = $this->params->get('language', $this->langTag); $this->langTag = $this->params->get('language', $this->langTag);
// setup the main language array // setup the main language array
@ -2872,9 +2881,9 @@ class Get
return 'error'; return 'error';
} }
// set the type name // set the type name
$type_name = ComponentbuilderHelper::safeString($field['settings']->type_name); $type_name = $this->safeName($field['settings']->type_name);
// set the name of the field // set the name of the field
$name = ComponentbuilderHelper::safeString($field['settings']->name); $name = $this->safeName($field['settings']->name);
// check that we have the poperties // check that we have the poperties
if (ComponentbuilderHelper::checkArray($field['settings']->properties)) if (ComponentbuilderHelper::checkArray($field['settings']->properties))
{ {
@ -2908,7 +2917,7 @@ class Get
{ {
// set other category details // set other category details
$this->catOtherName[$listViewName] = array( $this->catOtherName[$listViewName] = array(
'name' => ComponentbuilderHelper::safeString($otherName), 'name' => $this->safeName($otherName),
'views' => ComponentbuilderHelper::safeString($otherViews), 'views' => ComponentbuilderHelper::safeString($otherViews),
'view' => ComponentbuilderHelper::safeString($otherView) 'view' => ComponentbuilderHelper::safeString($otherView)
); );
@ -2928,7 +2937,7 @@ class Get
else else
{ {
// get value from xml // get value from xml
$xml = ComponentbuilderHelper::safeString($this->setPlaceholders(ComponentbuilderHelper::getBetween($field['settings']->xml, 'name="', '"'), $this->placeholders)); $xml = $this->safeName($this->setPlaceholders(ComponentbuilderHelper::getBetween($field['settings']->xml, 'name="', '"'), $this->placeholders));
// check if a value was found // check if a value was found
if (ComponentbuilderHelper::checkString($xml)) if (ComponentbuilderHelper::checkString($xml))
{ {
@ -2951,6 +2960,44 @@ class Get
return $name; return $name;
} }
/**
* Making field names safe
*
* @input string The you would like to make safe
*
* @returns string on success
**/
protected function safeName($string, $spacer = '_')
{
// use the new convention
if (1 == $this->fieldNameBuilder)
{
// 0nly continue if we have a string
if (ComponentbuilderHelper::checkString($string))
{
// check that the first character is not a number
if (is_numeric(substr($string, 0, 1)))
{
$string = ComponentbuilderHelper::replaceNumbers($string);
}
// remove all other strange characters
$string = trim($string);
$string = preg_replace('/'.$spacer.'+/', ' ', $string);
$string = preg_replace('/\s+/', ' ', $string);
// remove all and keep only characters and numbers
$string = preg_replace("/[^A-Za-z0-9 ]/", '', $string);
// replace white space with underscore (SAFEST OPTION)
$string = preg_replace('/\s+/', $spacer, $string);
// default is to return lower
return strtolower($string);
}
// not a string
return '';
}
// use the default (original behaviour/convention)
return ComponentbuilderHelper::safeString($string);
}
/** /**
* Count how many times the same field is used per view * Count how many times the same field is used per view
* *
@ -2994,13 +3041,13 @@ class Get
{ {
$counter = 1; $counter = 1;
// set the unique name // set the unique name
$uniqueName = ComponentbuilderHelper::safeString($name . '_' . $counter); $uniqueName = $this->safeName($name . '_' . $counter);
while (isset($this->uniqueNames[$view]['names'][$uniqueName])) while (isset($this->uniqueNames[$view]['names'][$uniqueName]))
{ {
// increment the number // increment the number
$counter++; $counter++;
// try again // try again
$uniqueName = ComponentbuilderHelper::safeString($name . '_' . $counter); $uniqueName = $this->safeName($name . '_' . $counter);
} }
// set the new name number // set the new name number
$this->uniqueNames[$view]['names'][$uniqueName] = $counter; $this->uniqueNames[$view]['names'][$uniqueName] = $counter;

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2" method="upgrade"> <extension type="component" version="3.2" method="upgrade">
<name>COM_COMPONENTBUILDER</name> <name>COM_COMPONENTBUILDER</name>
<creationDate>17th June, 2019</creationDate> <creationDate>18th June, 2019</creationDate>
<author>Llewellyn van der Merwe</author> <author>Llewellyn van der Merwe</author>
<authorEmail>llewellyn@joomlacomponentbuilder.com</authorEmail> <authorEmail>llewellyn@joomlacomponentbuilder.com</authorEmail>
<authorUrl>http://www.joomlacomponentbuilder.com</authorUrl> <authorUrl>http://www.joomlacomponentbuilder.com</authorUrl>