* @author Daniel Dimitrov * @date 07/06/2012 * @copyright Copyright (C) 2008 - 2012 compojoom.com . All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ defined('_JEXEC') or die('Restricted access'); /** * Class JEDcheckerReport * * This class is meant to be used by JED rules to * create a report. * * @since 1.0 */ class JEDcheckerReport extends JObject { /** * Contains the report data. * * @see reset * @var array */ protected $data; /** * The absolute path to the target extension. * * @var string */ protected $basedir; /** * Constructor. Initialises variables. * * @param mixed $properties Either and associative array or another * object to set the initial properties of the object. */ public function __construct($properties = null) { // Construct JObject parent::__construct($properties); // Initialise vars if (empty($this->data)) { $this->reset(); } } /** * Resets the report data. * * @return void */ public function reset() { $this->data = array(); $this->data['errors'] = array(); $this->data['compat'] = array(); $this->data['info'] = array(); $this->data['count'] = new stdClass; $this->data['count']->total = 0; $this->data['count']->errors = 0; $this->data['count']->compat = 0; $this->data['count']->warning = 0; $this->data['count']->info = 0; } /** * Adds an error to the report. * * @param string $location - The location of the error. Can be a path to a file or dir. * @param string $text - An optional description of the error. * @param integer $line - If $location is a file, you may specify the line where the * error occurred. * * @return void */ public function addError($location, $text = null, $line = 0) { $item = new stdClass; $item->location = $location; $item->line = $line; $item->text = $text; $this->addItem($item, 'errors'); } /** * Adds an error to the report. * * @param string $location - The location of the error. Can be a path to a file or dir. * @param string $text - An optional description of the error. * @param integer $line - If $location is a file, you may specify the line where the * error occurred. * * @return void */ public function addInfo($location, $text = null, $line = 0) { $item = new stdClass; $item->location = $location; $item->line = $line; $item->text = $text; $this->addItem($item, 'info'); } /** * Adds a compatibility issue to the report. * * @param string $location - The location of the issue. Can be a path to a file or dir. * @param string $text - An optional description of the issue * @param integer $line - If $location is a file, you may specify the line where the * issue occurred. * * @return void */ public function addCompat($location, $text = null, $line = 0) { $item = new stdClass; $item->location = $location; $item->line = $line; $item->text = $text; $this->addItem($item, 'compat'); } /** * Adds a warning issue to the report. * * @param string $location - The location of the issue. Can be a path to a file or dir. * @param string $text - An optional description of the issue * @param integer $line - If $location is a file, you may specify the line where the * issue occurred. * * @return void */ public function addWarning($location, $text = null, $line = 0) { $item = new stdClass; $item->location = $location; $item->line = $line; $item->text = $text; $this->addItem($item, 'warning'); } /** * Formats the existing report data into HTML and returns it. * * @return string The HTML report data */ public function getHTML() { $html = array(); if ($this->data['count']->total == 0) { // No errors or compatibility issues found $html[] = '
'; $html[] = JText::_('COM_JEDCHECKER_EVERYTHING_SEEMS_TO_BE_FINE_WITH_THAT_RULE'); $html[] = '
'; } else { $error_count = $this->data['count']->errors; $compat_count = $this->data['count']->compat; $info_count = $this->data['count']->info; $warning_count = $this->data['count']->warning; // Go through the error list if ($error_count > 0) { $collapseID = uniqid('error_'); $html[] = '
' . $error_count . ' ' . JText::_('COM_JEDCHECKER_ERRORS') . ' - Click to View Details
'; $html[] = '
'; } // Go through the compat list if ($compat_count > 0) { $collapseID = uniqid('warning_'); $html[] = '
' . $compat_count . ' ' . JText::_('COM_JEDCHECKER_COMPAT_ISSUES') . ' - Click to View Details
'; $html[] = '
'; } // Go through the compat list if ($info_count > 0) { $collapseID = uniqid('info_'); $html[] = '
' . $info_count . ' ' . JText::_('COM_JEDCHECKER_INFO') . ' - Click to View Details
'; $html[] = '
'; } // Go through the warning list if ($warning_count > 0) { $collapseID = uniqid('warning_'); $html[] = '
' . $warning_count . ' ' . JText::_('COM_JEDCHECKER_WARNING') . ' - Click to View Details
'; $html[] = '
'; } } return implode('', $html); } /** * Adds an item to the report data * * @param object $item - The item to add. * @param string $type - Optional item type. Can be 'errors' or 'compat'. * Defaults to 'errors'. * * @return void */ protected function addItem($item, $type = 'errors') { // Remove the base dir from the location if (!empty($this->basedir)) { $item->location = str_replace($this->basedir, '', $item->location); if ($item->location == '') { $item->location = '/'; } } // Add the item to the report data $this->data[$type][] = $item; $this->data['count']->total++; $this->data['count']->$type++; } }