New helper class: TemplateString - to allow extended syntaxes such as $this->location_id->org_id->parent_id->name$... to be progressively introduced and replace the heavy ToArgs()

SVN:trunk[1645]
2026-04-24 02:58:43 +02:00 · 2011-10-24 13:37:37 +00:00
parent 1eda4dde56
commit f8a582b375
4 changed files with 236 additions and 2 deletions
--- a/core/templatestring.class.inc.php
+++ b/core/templatestring.class.inc.php
@@ -0,0 +1,177 @@
+<?php
+// Copyright (C) 2010 Combodo SARL
+//
+//   This program is free software; you can redistribute it and/or modify
+//   it under the terms of the GNU General Public License as published by
+//   the Free Software Foundation; version 3 of the License.
+//
+//   This program is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU General Public License for more details.
+//
+//   You should have received a copy of the GNU General Public License
+//   along with this program; if not, write to the Free Software
+//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+/**
+ * Simple helper class to interpret and transform a template string
+ *
+ * Usage:
+ *     $oString = new TemplateString("Blah $this->friendlyname$ is in location $this->location_id->name$ ('$this->location_id->org_id->name$)");
+ *     echo $oString->Render(array('this' => $oContact));
+
+ * @author      Erwan Taloc <erwan.taloc@combodo.com>
+ * @author      Romain Quetiez <romain.quetiez@combodo.com>
+ * @author      Denis Flaven <denis.flaven@combodo.com>
+ * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ */
+
+/**
+ * Helper class
+ */
+class TemplateStringPlaceholder
+{
+	public $sToken;
+	public $sAttCode;
+	public $sFunction;
+	public $sParamName;
+	public $bIsValid;
+
+	public function __construct($sToken)
+	{
+		$this->sToken = $sToken;
+		$this->sAttcode = '';
+		$this->sFunction = '';
+		$this->sParamName = '';
+		$this->bIsValid = false; // Validity may be false in general, but it can work anyway (thanks to specialization) when rendering
+	}
+}
+
+/**
+ * Class TemplateString
+ */
+class TemplateString
+{
+	protected $m_sRaw;
+	protected $m_aPlaceholders;
+	    
+	public function __construct($sRaw)
+	{
+		$this->m_sRaw = $sRaw;
+		$this->m_aPlaceholders = null;
+	}
+	
+	/**
+	* Split the string into placholders
+	* @param Hash $aParamTypes Class of the expected parameters: hash array of '<param_id>' => '<class_name>'
+	* @return void
+	*/	  
+	protected function Analyze($aParamTypes = array())
+	{
+		if (!is_null($this->m_aPlaceholders)) return;
+
+		$this->m_aPlaceholders = array();
+		if (preg_match_all('/\\$([a-z0-9_]+(->[a-z0-9_]+)*)\\$/', $this->m_sRaw, $aMatches))
+		{
+			foreach($aMatches[1] as $sPlaceholder)
+			{
+				$oPlaceholder = new TemplateStringPlaceholder($sPlaceholder);
+				$oPlaceholder->bIsValid = false;
+				foreach ($aParamTypes as $sParamName => $sClass)
+				{
+					$sParamPrefix = $sParamName.'->';
+					if (substr($sPlaceholder, 0, strlen($sParamPrefix)) == $sParamPrefix)
+					{
+						// Todo - detect functions (label...)
+						$oPlaceholder->sFunction = '';
+
+						$oPlaceholder->sParamName = $sParamName;
+						$sAttcode = substr($sPlaceholder, strlen($sParamPrefix));
+						$oPlaceholder->sAttcode = $sAttcode;
+						$oPlaceholder->bIsValid = MetaModel::IsValidAttCode($sClass, $sAttcode, true /* extended */);
+					}
+				}
+
+				$this->m_aPlaceholders[] = $oPlaceholder;
+			}
+		}
+	}
+
+	/**
+	* Return the placeholders (for reporting purposes)
+	* @return void
+	*/	  
+	public function GetPlaceholders()
+	{
+		return $this->m_aPlaceholders;
+	}
+
+	/**
+	* Check the format when possible
+	* @param Hash $aParamTypes Class of the expected parameters: hash array of '<param_id>' => '<class_name>'
+	* @return void
+	*/	  
+	public function IsValid($aParamTypes = array())
+	{
+		$this->Analyze($aParamTypes);
+
+		foreach($this->m_aPlaceholders as $oPlaceholder)
+		{
+			if (!$oPlaceholder->bIsValid)
+			{
+				if (count($aParamTypes) == 0)
+				{
+					return false;
+				}
+				if (array_key_exists($oPlaceholder->sParamName, $aParamTypes))
+				{
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+	/**
+	* Apply the given parameters to replace the placeholders
+	* @param Hash $aParamValues Value of the expected parameters: hash array of '<param_id>' => '<value>'
+	* @return void
+	*/	  
+	public function Render($aParamValues = array())
+	{
+		$aParamTypes = array();
+		foreach($aParamValues as $sParamName => $value)
+		{
+			$aParamTypes[$sParamName] = get_class($value);
+		}
+		$this->Analyze($aParamTypes);
+
+		$aSearch = array();
+		$aReplace = array();
+		foreach($this->m_aPlaceholders as $oPlaceholder)
+		{
+			if (array_key_exists($oPlaceholder->sParamName, $aParamValues))
+			{
+				$oRef = $aParamValues[$oPlaceholder->sParamName];
+				try
+				{
+					$value = $oRef->Get($oPlaceholder->sAttcode);
+					$aSearch[] = '$'.$oPlaceholder->sToken.'$';
+					$aReplace[] = $value;
+					$oPlaceholder->bIsValid = true;
+				}
+				catch(Exception $e)
+				{
+					$oPlaceholder->bIsValid = false;
+				}
+			}
+			else
+			{
+				$oPlaceholder->bIsValid = false;
+			}
+		}
+		return str_replace($aSearch, $aReplace, $this->m_sRaw);
+	}
+}
+?>