From 5616ea01a30f4e514950d08554a373a865935f82 Mon Sep 17 00:00:00 2001
From: physikerwelt <wiki@physikerwelt.de>
Date: Wed, 24 Apr 2013 08:21:35 +0000
Subject: [PATCH] Remove even more unused variables

* $inputhash is also never used.
* Additional comments.
* allow creation of math renderer without $tex code

Change-Id: I64c181408e8acd16aee7a53a81a176b62a6726b5
---
 MathRenderer.php | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/MathRenderer.php b/MathRenderer.php
index feaf38ea8..78ba02b1a 100644
--- a/MathRenderer.php
+++ b/MathRenderer.php
@@ -9,7 +9,12 @@
  */
 
 /**
- * Abstract base class for math renderers using different technologies.
+ * Abstract base class with static methods for rendering the <math> tags using 
+ * different technologies. These static methods create a new instance of the 
+ * extending classes and render the math tags based on the mode setting of the user.
+ * Furthermore this class handles the caching of the rendered output and provides
+ *  debug information,
+ * if run in mathdebug mode.
  *
  * @author Tomasz Wegrzanowski
  * @author Brion Vibber
@@ -17,11 +22,15 @@
  */
 abstract class MathRenderer {
 	/**
-	 *  The following variables should made private, as soon it can be verified that they are not being directly accessed by other extensions.
+	 *  The following variables should made private, as soon it can be verified
+	 *  that they are not being directly accessed by other extensions.
 	 */
 	var $mode = MW_MATH_PNG;
 	var $tex = '';
-	var $inputhash = '';
+	/**
+	 * is calculated by texvc.
+	 * @var string
+	 */
 	var $hash = '';
 	var $html = '';
 	var $mathml = '';
@@ -32,10 +41,10 @@ abstract class MathRenderer {
 	/**
 	 * Constructs a base MathRenderer
 	 *
-	 * @param string $tex LaTeX markup
-	 * @param array $params HTML attributes
+	 * @param string $tex (optional) LaTeX markup
+	 * @param array $params (optional) HTML attributes
 	 */
-	public function __construct( $tex, $params = array() ) {
+	public function __construct( $tex='', $params = array() ) {
 		$this->tex = $tex;
 		$this->params = $params;
 	}
@@ -77,17 +86,21 @@ abstract class MathRenderer {
 			default:
 				$renderer = new MathTexvc( $tex, $params );
 		}
+		wfDebugLog ( "Math", 'start rendering $' . $renderer->tex . '$' );
 		return $renderer;
 	}
 
 	/**
-	 * Returns TeX to HTML
+	 * Performs the rendering and returns the rendered element that needs to be embedded.
 	 *
 	 * @return string of rendered HTML
 	 */
 	abstract public function render();
 
+
 	/**
+	 * texvc error messages
+	 * TODO: update to MathML
 	 * Returns an internationalized HTML error string
 	 *
 	 * @param string $msg message key for specific error
@@ -147,7 +160,13 @@ abstract class MathRenderer {
 	}
 
 	/**
-	 * Writes rendering entry to database
+	 * Writes rendering entry to database.
+	 *
+	 * WARNING: Use writeCache() instead of this method to be sure that all
+	 * renderer specific (such as squid caching) are taken into account.
+	 * This function stores the values that are currently present in the class to the database even if they are empty.
+	 *
+	 * This function can be seen as protected function.
 	 */
 	public function writeToDatabase() {
 		# Now save it back to the DB: