joomla/jedchecker
33
2
Fork 0
mirror of https://github.com/joomla-extensions/jedchecker.git synced 2024-12-29 04:42:36 +00:00
Code Issues Releases Activity

Joomla! code style fixes

Browse Source
This commit is contained in:
Denis Ryabov 2021-04-04 13:59:50 +03:00
parent 01c5c5e550
commit ae251b5d5b
1 changed files with 47 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
administrator/components/com_jedchecker/libraries/rules/xmlmanifest.php
View File

@ -17,7 +17,7 @@ require_once JPATH_COMPONENT_ADMINISTRATOR . '/models/rule.php';
/** /**
* class JedcheckerRulesXMLManifest * class JedcheckerRulesXMLManifest
* *
* This class validates all xml manifestes * This class validates all XML manifests
* *
* @since 2.3 * @since 2.3
*/ */
@ -75,9 +75,14 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
*/ */
protected $DTDAttrRules; protected $DTDAttrRules;
/**
* List of extension types
*
* @var string[]
*/
protected $types = array( protected $types = array(
'component', 'file', 'language', 'library', 'component', 'file', 'language', 'library',
'module', 'package', 'plugin', 'template' 'module', 'package', 'plugin', 'template'
); );
/** /**
@ -122,21 +127,26 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
return false; return false;
} }
// check extension type // Check extension type
$type = (string) $xml['type']; $type = (string) $xml['type'];
if (!in_array($type, $this->types, true)) if (!in_array($type, $this->types, true))
{ {
$this->report->addError($file, JText::sprintf('COM_JEDCHECKER_MANIFEST_UNKNOWN_TYPE', $type)); $this->report->addError($file, JText::sprintf('COM_JEDCHECKER_MANIFEST_UNKNOWN_TYPE', $type));
return true; return true;
} }
// load DTD-like data for this extension type // Load DTD-like data for this extension type
$json_filename = __DIR__ . '/xmlmanifest/dtd_' . $type . '.json'; $json_filename = __DIR__ . '/xmlmanifest/dtd_' . $type . '.json';
if (!is_file($json_filename)) if (!is_file($json_filename))
{ {
$this->report->addError($file, JText::sprintf('COM_JEDCHECKER_MANIFEST_TYPE_NOT_ACCEPTED', $type)); $this->report->addError($file, JText::sprintf('COM_JEDCHECKER_MANIFEST_TYPE_NOT_ACCEPTED', $type));
return true; return true;
} }
$data = json_decode(file_get_contents($json_filename), true); $data = json_decode(file_get_contents($json_filename), true);
$this->DTDNodeRules = $data['nodes']; $this->DTDNodeRules = $data['nodes'];
$this->DTDAttrRules = $data['attributes']; $this->DTDAttrRules = $data['attributes'];
@ -144,7 +154,7 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
$this->errors = array(); $this->errors = array();
$this->warnings = array(); $this->warnings = array();
// validate manifest // Validate manifest
$this->validateXml($xml, 'extension'); $this->validateXml($xml, 'extension');
if (count($this->errors)) if (count($this->errors))
@ -162,8 +172,10 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
} }
/** /**
* @param JXMLElement $node * @param SimpleXMLElement $node XML node object
* @param string $name * @param string $name XML node name
*
* @return void
*/ */
protected function validateXml($node, $name) protected function validateXml($node, $name)
{ {
@ -174,12 +186,12 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
{ {
foreach ($node->attributes() as $attr) foreach ($node->attributes() as $attr)
{ {
$attr_name = (string)$attr->getName(); $attrName = (string)$attr->getName();
if (!in_array($attr_name, $DTDattributes, true)) if (!in_array($attrName, $DTDattributes, true))
{ {
// The node has unknown attribute // The node has unknown attribute
$this->warnings[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_UNKNOWN_ATTRIBUTE', $name, $attr_name); $this->warnings[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_UNKNOWN_ATTRIBUTE', $name, $attrName);
} }
} }
} }
@ -202,6 +214,7 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
foreach ($DTDchildren as $child => $mode) foreach ($DTDchildren as $child => $mode)
{ {
$count = $node->$child->count(); $count = $node->$child->count();
switch ($mode) switch ($mode)
{ {
case '!': case '!':
@ -213,6 +226,7 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
default: default:
continue 2; continue 2;
} }
if ($count === 0) if ($count === 0)
{ {
$errors[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_MISSED_REQUIRED', $name, $child); $errors[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_MISSED_REQUIRED', $name, $child);
@ -221,20 +235,22 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
{ {
$errors[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_MULTIPLE_FOUND', $name, $child); $errors[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_MULTIPLE_FOUND', $name, $child);
} }
unset($errors); unset($errors);
} }
// 2) check unknown/multiple elements // 2) check unknown/multiple elements
// collect unique child node names // Collect unique child node names
$child_names = array(); $childNames = array();
foreach ($node as $child) foreach ($node as $child)
{ {
$child_names[$child->getName()] = 1; $childNames[$child->getName()] = 1;
} }
$child_names = array_keys($child_names); $childNames = array_keys($childNames);
foreach ($child_names as $child) foreach ($childNames as $child)
{ {
if (!isset($DTDchildren[$child])) if (!isset($DTDchildren[$child]))
{ {
@ -252,6 +268,7 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
// Extra checks (if exist) // Extra checks (if exist)
$method = 'validateXml' . $name; $method = 'validateXml' . $name;
if (method_exists($this, $method)) if (method_exists($this, $method))
{ {
$this->$method($node); $this->$method($node);
@ -260,29 +277,34 @@ class JedcheckerRulesXMLManifest extends JEDcheckerRule
// Recursion // Recursion
foreach ($node as $child) foreach ($node as $child)
{ {
$child_name = $child->getName(); $childName = $child->getName();
if (isset($this->DTDNodeRules[$child_name])) {
$this->validateXml($child, $child_name); if (isset($this->DTDNodeRules[$childName]))
{
$this->validateXml($child, $childName);
} }
} }
} }
/** /**
* Extra check for menu nodes * @param SimpleXMLElement $node XML node
* @param JXMLElement $node *
* @return void
*/ */
protected function validateXmlMenu($node) protected function validateXmlMenu($node)
{ {
if (isset($node['link'])) if (isset($node['link']))
{ {
// The "link" attribute overrides any other link-related attributes (warn if they present) // The "link" attribute overrides any other link-related attributes (warn if they present)
$skip_attrs = array('act', 'controller', 'layout', 'sub', 'task', 'view'); $skipAttrs = array('act', 'controller', 'layout', 'sub', 'task', 'view');
foreach ($node->attributes() as $attr) foreach ($node->attributes() as $attr)
{ {
$attr_name = $attr->getName(); $attrName = $attr->getName();
if (in_array($attr_name, $skip_attrs, true))
if (in_array($attrName, $skipAttrs, true))
{ {
$this->warnings[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_MENU_UNUSED_ATTRIBUTE', $attr_name); $this->warnings[] = JText::sprintf('COM_JEDCHECKER_MANIFEST_MENU_UNUSED_ATTRIBUTE', $attrName);
} }
} }
} }