basedir, '.php$', true, true);
$this->leftover_folders = explode(',', $this->params->get('leftover_folders'));
foreach ($files as $file)
{
if (!$this->excludeResource($file))
{
// Process the file
if ($this->find($file))
{
// Error messages are set by find() based on the errors found.
}
}
}
}
/**
* Check if the given resourse is part
*
* @param string $file The file name to test
*
* @return boolean
*/
private function excludeResource($file)
{
// Warn about code versioning files included
$result = false;
foreach ($this->leftover_folders as $leftover_folder)
{
if (strpos($file, $leftover_folder) !== false)
{
$error_message = JText::_("COM_JEDCHECKER_ERROR_FRAMEWORK_GIT") . ":";
$this->report->addWarning($file, $error_message, 0);
$result = true;
}
}
return $result;
}
/**
* reads a file and searches for any function defined in the params
*
* @param string $file The file name
*
* @return boolean True if the statement was found, otherwise False.
*/
protected function find($file)
{
$content = (array) file($file);
$result = false;
foreach ($this->getTests() as $testObject)
{
if ($this->runTest($file, $content, $testObject))
{
$result = true;
}
}
return $result;
}
/**
* runs tests and reports to the appropriate function if strings match.
*
* @param string $file The file name
* @param array $content The file content
* @param object $testObject The test object generated by getTests()
*
* @return boolean
*/
private function runTest($file, $content, $testObject)
{
$error_count = 0;
foreach ($content as $line_number => $line)
{
foreach ($testObject->tests AS $singleTest)
{
if (stripos($line, $singleTest) !== false)
{
$line = str_ireplace($singleTest, '' . $singleTest . '', $line);
$error_message = JText::_('COM_JEDCHECKER_ERROR_FRAMEWORK_' . strtoupper($testObject->group)) . ':' . $line . '
';
switch ($testObject->kind)
{
case 'error':$this->report->addError($file, $error_message, $line_number);
break;
case 'warning':$this->report->addWarning($file, $error_message, $line_number);
break;
case 'compatibility':$this->report->addCompat($file, $error_message, $line_number);
break;
default:
// Case 'notice':
$this->report->addInfo($file, $error_message, $line_number);
break;
}
}
// If you scored 10 errors on a single file, that's enough for now.
if ($error_count > 10)
{
return true;
}
}
}
return $error_count > 0;
}
/**
* Lazyloads the tests from the framework.ini params.
* The whole structure depends on the file. The vars
* error_groups, warning_groups, notice_groups, compatibility_groups
* serve as lists of other rules, which are grouped and show a different error message per rule.
* Please note: if you want to add more rules, simply do so in the .ini file
* BUT MAKE SURE that you add the relevant key to the translation files:
* COM_JEDCHECKER_ERROR_NOFRAMEWOR_SOMEKEY
*
* @return boolean
*/
private function getTests()
{
if (!$this->tests)
{
// Build the test array. Please read the comments in the framework.ini file
$this->tests = array();
$testNames = array('error','warning','notice','compatibility');
foreach ($testNames as $test)
{
foreach ( explode(",", $this->params->get($test . '_groups')) as $group)
{
$newTest = new stdClass;
$newTest->group = $group;
$newTest->kind = $test;
$newTest->tests = explode(",", $this->params->get($group));
$this->tests[] = $newTest;
}
}
}
return $this->tests;
}
}