joomla/Component-Builder
39
25
Fork 11
Code Issues 75 Pull Requests Projects 4 Wiki Activity

Updated the compiler to also target JText::script() & Joomla.JText._() in language constant replacement. Added field counter. Resolved gh-198

Browse Source
This commit is contained in:
Llewellyn van der Merwe
2017-12-14 15:30:21 +02:00
parent 20f5a083f0
commit 95716e22cf
11 changed files with 250 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
admin/helpers/compiler/a_Get.php
View File

@ -218,6 +218,32 @@ class Get
*/
protected $existingLangStrings = array();
/**
* The Language JS matching check
*
* @var array
*/
public $langMismatch = array();
/**
* The Language SC matching check
*
* @var array
*/
public $langMatch = array();
/**
* The Language string targets
*
* @var array
*/
public $langStringTargets = array(
'Joomla.JText._(',
'JText::script(',
'JText::_(',
'JText::sprintf('
);
/**
* The Component Code Name
*
@ -1773,18 +1799,6 @@ class Get
$this->getModule[$this->target][$view->code] = true;
}
}
// (TODO) we may want to automate this .... lets see if someone asks
// if (strpos($view->$scripter,"token") !== false || strpos($view->$scripter,"task=ajax") !== false)
// {
// if(!isset($this->customScriptBuilder['token']))
// {
// $this->customScriptBuilder['token'] = array();
// }
// if (!isset($this->customScriptBuilder['token'][$this->target.$view->code]) || !$this->customScriptBuilder['token'][$this->target.$view->code])
// {
// $this->customScriptBuilder['token'][$this->target.$view->code] = true;
// }
// }
}
}
// add_Ajax for this view
@ -3109,18 +3123,64 @@ class Get
*/
public function setLangStrings($content)
{
// first check if we should continue
if (strpos($content, 'JText::_(') !== false || strpos($content, 'JText::sprintf(') !== false)
// get targets to search for
$langStringTargets = array_filter(
$this->langStringTargets,
function($get) use($content){
if (strpos($content, $get) !== false)
{
return true;
}
return false;
});
// check if we should continue
if (ComponentbuilderHelper::checkArray($langStringTargets))
{
// insure string is not broken
$content = str_replace('COM_###COMPONENT###',$this->langPrefix,$content);
// first get the Joomla.JText._()
if (in_array('Joomla.JText._(',$langStringTargets))
{
$jsTEXT[] = ComponentbuilderHelper::getAllBetween($content, "Joomla.JText._('","'");
$jsTEXT[] = ComponentbuilderHelper::getAllBetween($content, 'Joomla.JText._("','"');
// combine into one array
$jsTEXT = ComponentbuilderHelper::mergeArrays($jsTEXT);
// we need to add a check to insure these JavaScript lang matchup
if (ComponentbuilderHelper::checkArray($jsTEXT)) //<-- not really needed hmmm
{
// load the JS text to mismatch array
$langCheck[] = $jsTEXT;
$this->langMismatch = ComponentbuilderHelper::mergeArrays(array($jsTEXT, $this->langMismatch));
}
}
// now get the JText::script()
if (in_array('JText::script(',$langStringTargets))
{
$scTEXT[] = ComponentbuilderHelper::getAllBetween($content, "JText::script('","'");
$scTEXT[] = ComponentbuilderHelper::getAllBetween($content, 'JText::script("','"');
// combine into one array
$scTEXT = ComponentbuilderHelper::mergeArrays($scTEXT);
// we need to add a check to insure these JavaScript lang matchup
if (ComponentbuilderHelper::checkArray($scTEXT)) //<-- not really needed hmmm
{
// load the Script text to match array
$langCheck[] = $scTEXT;
$this->langMatch = ComponentbuilderHelper::mergeArrays(array($scTEXT, $this->langMatch));
}
}
// set language data
$langCheck[] = ComponentbuilderHelper::getAllBetween($content, "JText::_('","'");
$langCheck[] = ComponentbuilderHelper::getAllBetween($content, 'JText::_("','"');
$langCheck[] = ComponentbuilderHelper::getAllBetween($content, "JText::sprintf('","'");
$langCheck[] = ComponentbuilderHelper::getAllBetween($content, 'JText::sprintf("','"');
foreach($langStringTargets as $langStringTarget)
{
// need some special treatment here
if ($langStringTarget === 'Joomla.JText._(' || $langStringTarget === 'JText::script(')
{
continue;
}
$langCheck[] = ComponentbuilderHelper::getAllBetween($content, $langStringTarget."'","'");
$langCheck[] = ComponentbuilderHelper::getAllBetween($content, $langStringTarget.'"','"');
}
$langArray = ComponentbuilderHelper::mergeArrays($langCheck);
if (ComponentbuilderHelper::checkArray($langArray))
if (ComponentbuilderHelper::checkArray($langArray)) //<-- not really needed hmmm
{
foreach ($langArray as $string)
{
@ -3135,10 +3195,12 @@ class Get
{
$this->langContent[$this->lang][$keyLang] = trim($string);
}
$langHolders["JText::_('".$string."')"] = "JText::_('".$keyLang."')";
$langHolders['JText::_("'.$string.'")'] = 'JText::_("'.$keyLang.'")';
$langHolders["JText::sprintf('".$string."',"] = "JText::sprintf('".$keyLang."',";
$langHolders['JText::sprintf("'.$string.'",'] = 'JText::sprintf("'.$keyLang.'",';
// load the language targets
foreach($langStringTargets as $langStringTarget)
{
$langHolders[$langStringTarget."'".$string."'"] = $langStringTarget."'".$keyLang."'";
$langHolders[$langStringTarget.'"'.$string.'"'] = $langStringTarget.'"'.$keyLang.'"';
}
}
// only continue if we have value to replace
if (isset($langHolders) && ComponentbuilderHelper::checkArray($langHolders))
@ -4772,21 +4834,33 @@ class Get
*/
protected function setReverseLangPlaceholders($updateString, $string)
{
if (strpos($string, 'JText::_(') !== false || strpos($string, 'JText::sprintf(') !== false)
// get targets to search for
$langStringTargets = array_filter(
$this->langStringTargets,
function($get) use($string){
if (strpos($string, $get) !== false)
{
return true;
}
return false;
});
// check if we should continue
if (ComponentbuilderHelper::checkArray($langStringTargets))
{
$langHolders = array();
// set the lang for both since we don't know what area is being targeted
$_tmp = $this->lang;
$this->lang = 'both';
// set language data
$langCheck[] = ComponentbuilderHelper::getAllBetween($string, "JText::_('","'");
$langCheck[] = ComponentbuilderHelper::getAllBetween($string, 'JText::_("','"');
$langCheck[] = ComponentbuilderHelper::getAllBetween($string, "JText::sprintf('","'");
$langCheck[] = ComponentbuilderHelper::getAllBetween($string, 'JText::sprintf("','"');
foreach($langStringTargets as $langStringTarget)
{
$langCheck[] = ComponentbuilderHelper::getAllBetween($string, $langStringTarget."'","'");
$langCheck[] = ComponentbuilderHelper::getAllBetween($string, $langStringTarget."'","'");
}
// merge arrays
$langArray = ComponentbuilderHelper::mergeArrays($langCheck);
// continue only if strings were found
if (ComponentbuilderHelper::checkArray($langArray))
if (ComponentbuilderHelper::checkArray($langArray)) //<-- not really needed hmmm
{
foreach ($langArray as $lang)
{
@ -4803,10 +4877,11 @@ class Get
$this->langContent[$this->lang][$keyLang] = trim($lang);
}
// reverse the placeholders
$langHolders["JText::_('".$keyLang."')"] = "JText::_('".$lang."')";
$langHolders['JText::_("'.$keyLang.'")'] = 'JText::_("'.$lang.'")';
$langHolders["JText::sprintf('".$keyLang."',"] = "JText::sprintf('".$lang."',";
$langHolders['JText::sprintf("'.$keyLang.'",'] = 'JText::sprintf("'.$lang.'",';
foreach($langStringTargets as $langStringTarget)
{
$langHolders[$langStringTarget."'".$keyLang."'"] = $langStringTarget."'".$lang."'";
$langHolders[$langStringTarget.'"'.$keyLang.'"'] = $langStringTarget.'"'.$lang.'"';
}
}
// return the found placeholders
$updateString = $this->setPlaceholders($updateString, $langHolders);

7
admin/helpers/compiler/b_Structure.php
View File

@ -59,6 +59,13 @@ class Structure extends Get
*/
public $lineCount = 0;
/**
* The field counter
*
* @var int
*/
public $fieldCount = 0;
/**
* The seconds counter
*

33
admin/helpers/compiler/c_Fields.php
View File

@ -497,6 +497,8 @@ class Fields extends Structure
);
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// if created is not set
if (!isset($this->fieldsNames[$viewName]['created']))
@ -514,6 +516,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Date Created Field. Type: Calendar (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// if created_by is not set
if (!isset($this->fieldsNames[$viewName]['created_by']))
@ -528,6 +532,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " User Created Field. Type: User (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// if published is not set
if (!isset($this->fieldsNames[$viewName]['published']))
@ -541,6 +547,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Published Field. Type: List (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
foreach (array('JPUBLISHED' => 1, 'JUNPUBLISHED' => 0, 'JARCHIVED' => 2, 'JTRASHED' => -2) as $text => $value)
{
$optionXML = $fieldXML->addChild('option');
@ -565,6 +573,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Date Modified Field. Type: Calendar (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// if modified_by is not set
if (!isset($this->fieldsNames[$viewName]['modified_by']))
@ -581,6 +591,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " User Modified Field. Type: User (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// check if view has access
if (isset($this->accessBuilder[$viewName]) && ComponentbuilderHelper::checkString($this->accessBuilder[$viewName]) && !isset($this->fieldsNames[$viewName]['access']))
@ -597,6 +609,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Access Field. Type: Accesslevel (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// if ordering is not set
if (!isset($this->fieldsNames[$viewName]['ordering']))
@ -615,6 +629,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Ordering Field. Type: Numbers (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// if version is not set
if (!isset($this->fieldsNames[$viewName]['version']))
@ -632,6 +648,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Version Field. Type: Text (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// check if metadata is added to this view
if (isset($this->metadataBuilder[$viewName]) && ComponentbuilderHelper::checkString($this->metadataBuilder[$viewName]))
@ -648,6 +666,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Metakey Field. Type: Textarea (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
// metadesc
$attributes['name'] = 'metadesc';
$attributes['label'] = 'JFIELD_META_DESCRIPTION_LABEL';
@ -655,6 +675,8 @@ class Fields extends Structure
$this->xmlComment($fieldSetXML, $this->setLine(__LINE__) . " Metadesc Field. Type: Textarea (joomla)");
$fieldXML = $fieldSetXML->addChild('field');
$this->xmlAddAttributes($fieldXML, $attributes);
// count the static field created
$this->fieldCount++;
}
// load the dynamic fields now
if (count($dynamicFieldsXML))
@ -685,6 +707,8 @@ class Fields extends Structure
'description' => 'JFIELD_METADATA_ROBOTS_DESC'
);
$this->xmlAddAttributes($robots, $attributes);
// count the static field created
$this->fieldCount++;
$options = array(
'JGLOBAL_USE_GLOBAL' => '',
'JGLOBAL_INDEX_FOLLOW' => 'index, follow',
@ -709,6 +733,8 @@ class Fields extends Structure
'size' => 20
);
$this->xmlAddAttributes($author, $attributes);
// count the static field created
$this->fieldCount++;
// rights
$this->xmlComment($fieldsFieldSetXML, $this->setLine(__LINE__) . " Rights Field. Type: Textarea (joomla)");
$rights = $fieldsFieldSetXML->addChild('field');
@ -723,6 +749,8 @@ class Fields extends Structure
'rows' => 2
);
$this->xmlAddAttributes($rights, $attributes);
// count the static field created
$this->fieldCount++;
}
// just to be safe, lets clear the view placeholders
$this->clearFromPlaceHolders('view');
@ -2342,7 +2370,8 @@ class Fields extends Structure
public function xmlAppend(&$xml, $node)
{
if (!$node)
{ // element was not returned
{
// element was not returned
return;
}
switch (get_class($node))
@ -2364,6 +2393,8 @@ class Fields extends Structure
$xml = simplexml_import_dom($domXML);
break;
}
// count the dynamic fields created
$this->fieldCount++;
}
/**