From 796029932b87e46d317262ab9562a5c091027dfc Mon Sep 17 00:00:00 2001 From: xue <> Date: Sun, 20 Nov 2005 23:48:11 +0000 Subject: --- framework/Exceptions/TErrorHandler.php | 11 +- framework/Exceptions/messages.txt | 38 +- framework/Web/Services/TPageService.php | 4 +- framework/Web/UI/TTemplateManager.php | 630 -------------------------------- framework/Web/UI/TThemeManager.php | 338 ----------------- 5 files changed, 19 insertions(+), 1002 deletions(-) delete mode 100644 framework/Web/UI/TTemplateManager.php delete mode 100644 framework/Web/UI/TThemeManager.php (limited to 'framework') diff --git a/framework/Exceptions/TErrorHandler.php b/framework/Exceptions/TErrorHandler.php index e9ef1f33..779224ca 100644 --- a/framework/Exceptions/TErrorHandler.php +++ b/framework/Exceptions/TErrorHandler.php @@ -33,8 +33,8 @@ * The templates error.html and exception.html are default ones * that are used if no other appropriate templates are available. * Note, these templates are not Prado control templates. They are simply - * templates with keywords (e.g. %%ErrorMessage%%, %%Version%%) - * to be replaced with corresponding information. + * html files with keywords (e.g. %%ErrorMessage%%, %%Version%%) + * to be replaced with the corresponding information. * * By default, TErrorHandler is registered with {@link TApplication} as the * error handler module. It can be accessed via {@link TApplication::getErrorHandler()}. @@ -60,7 +60,7 @@ class TErrorHandler extends TComponent implements IModule */ const EXCEPTION_FILE_NAME='exception'; /** - * number of lines to be displayed in case of an exception + * number of lines before and after the error line to be displayed in case of an exception */ const SOURCE_LINES=12; @@ -106,6 +106,9 @@ class TErrorHandler extends TComponent implements IModule $this->_id=$value; } + /** + * @return string the directory containing error template files. + */ public function getErrorTemplatePath() { return $this->_templatePath; @@ -217,7 +220,7 @@ class TErrorHandler extends TComponent implements IModule { echo "Recursive Error\n"; echo "

Recursive Error

\n"; - echo "

".$exception."

\n"; + echo "

".$exception->__toString()."

\n"; echo ""; } else diff --git a/framework/Exceptions/messages.txt b/framework/Exceptions/messages.txt index 0d3d7a1d..72e159e8 100644 --- a/framework/Exceptions/messages.txt +++ b/framework/Exceptions/messages.txt @@ -95,31 +95,13 @@ authmanager_usermanager_invalid = TAuthManager.UserManager '%s' does not refer authmanager_usermanager_unchangeable = TAuthManager.UserManager cannot be modified after the module is initialized. authmanager_session_required = TAuthManager requires a session application module. -body_contents_not_allowed = %s: body contents are not allowed. -control_id_not_unique = Control ID '%s' is not unique for control type '%s'. -control_not_found = Unable to find a control with ID '%s'. -control_not_in_form = Control '%s' is not enclosed within a server form. -data_not_iterable = Data is not iterable. An array or an object implementing Traversable is required. -event_not_defined = %s: event is not defined. -expecting_closing_tag = Line %d: expecting closing tag %s. -index_out_of_range = Index '%s' is out of range. -invalid_accesskey = %s.AccessKey: only one character is allowed. -invalid_control_id = Invalid control ID '%s' for control type '%s'. -invalid_enum_value = Invalid value '%s' for enumeration type (%s) -invalid_event_handler = Invalid event handler '%s' for event '%s'. -invalid_expression = Invalid expression '%s': %s. -invalid_statements = Invalid statements '%s': %s. -invalid_subproperty = Invalid sub-property '%s'. -invalid_style_value = %s.Style: only string is allowed. -multiple_form_not_allowed = Multiple server forms are not allowed. -must_be_component = %s must extend from TComponent. -no_comments_in_property = Line %d: comments are not allowed in property values. -property_not_defined = %s: property is not defined. -property_read_only = %s: property is read-only. -skinid_set_after_applied = %s: SkinID cannot be set after the skin is applied. -skinid_set_after_preinit = %s: SkinID cannot be set after PreInit stage. -stylesheet_applied = %s: StyleSheet skin is already applied. -enabletheming_after_preinit = %s: EnableTheme cannot be set after PreInit stage. -nonunique_template_directive = Line %d: at most one template directive is allowed. -unexpected_closing_tag = Line %d: unexpected closing tag %s. -unexpected_matching = Unexpected matching: %s. Please report this problem to PRADO developer team. +thememanager_basepath_invalid = TThemeManager.BasePath '%s' is not a valid directory. +thememanager_basepath_unchangeable = TThemeManager.BasePath cannot be modified after the module is initialized. + +theme_baseurl_required = TThemeManager.BasePath is required. By default, a directory named 'themes' under the directory containing the application entry script is assumed. +theme_path_inexistent = Theme path '%s' does not exist. +theme_control_nested = Skin for control type '%s' in theme '%s' cannot be within another skin. +theme_skinid_duplicated = SkinID '%s.%s' is duplicated in theme '%s'. +theme_databind_forbidden = Databind cannot be used in theme '%s' for control skin '%s.%s' about property '%s'. +theme_property_readonly = Skin is being applied to a read-only control property '%s.%s'. +theme_property_undefined = Skin is being applied to an inexistent control property '%s.%s'. diff --git a/framework/Web/Services/TPageService.php b/framework/Web/Services/TPageService.php index df239088..048bead3 100644 --- a/framework/Web/Services/TPageService.php +++ b/framework/Web/Services/TPageService.php @@ -11,8 +11,8 @@ */ Prado::using('System.Web.UI.TPage'); -Prado::using('System.Web.UI.TTemplateManager'); -Prado::using('System.Web.UI.TThemeManager'); +Prado::using('System.Web.TTemplateManager'); +Prado::using('System.Web.TThemeManager'); Prado::using('System.Web.TAssetManager'); /** diff --git a/framework/Web/UI/TTemplateManager.php b/framework/Web/UI/TTemplateManager.php deleted file mode 100644 index 6b9ccfc0..00000000 --- a/framework/Web/UI/TTemplateManager.php +++ /dev/null @@ -1,630 +0,0 @@ - - * @link http://www.pradosoft.com/ - * @copyright Copyright © 2005 PradoSoft - * @license http://www.pradosoft.com/license/ - * @version $Revision: $ $Date: $ - * @package System.Web.UI - */ - -/** - * TTemplateManager class - * - * TTemplateManager manages the loading and parsing of control templates. - * - * Given a class name, TTemplateManager tries to locate the corresponding template - * file under the directory containing the class file. The name of the template file - * is the class name with the extension '.tpl'. - * - * By default, TTemplateManager is registered with {@link TPageService} as the - * template manager module that can be accessed via {@link TPageService::getTemplateManager()}. - * - * @author Qiang Xue - * @version $Revision: $ $Date: $ - * @package System.Web.UI - * @since 3.0 - */ -class TTemplateManager extends TComponent implements IModule -{ - /** - * Template file extension - */ - const TEMPLATE_FILE_EXT='.tpl'; - /** - * Prefix of the cache variable name for storing parsed templates - */ - const TEMPLATE_CACHE_PREFIX='prado:template:'; - /** - * @var TApplication application instance - */ - private $_application; - /** - * @var string module ID - */ - private $_id; - - /** - * Initializes the module. - * This method is required by IModule and is invoked by application. - * It starts output buffer if it is enabled. - * @param TApplication application - * @param TXmlElement module configuration - */ - public function init($application,$config) - { - $this->_application=$application; - $application->getService()->setTemplateManager($this); - } - - /** - * @return string id of this module - */ - public function getID() - { - return $this->_id; - } - - /** - * @param string id of this module - */ - public function setID($value) - { - $this->_id=$value; - } - - /** - * Loads the template corresponding to the specified class name. - * @return ITemplate template for the class name, null if template doesn't exist. - */ - public function getTemplateByClassName($className) - { - $class=new ReflectionClass($className); - $tplFile=dirname($class->getFileName()).'/'.$className.self::TEMPLATE_FILE_EXT; - return $this->getTemplateByFileName($tplFile); - } - - /** - * Loads the template from the specified file. - * @return ITemplate template parsed from the specified file, null if the file doesn't exist. - */ - public function getTemplateByFileName($fileName) - { - if(($fileName=realpath($fileName))!==false && is_file($fileName)) - { - if(($cache=$this->_application->getCache())===null) - return new TTemplate(file_get_contents($fileName),dirname($fileName),$fileName); - else - { - $array=$cache->get(self::TEMPLATE_CACHE_PREFIX.$fileName); - if(is_array($array)) - { - list($template,$timestamp)=$array; - if(filemtime($fileName)<$timestamp) - return $template; - } - $template=new TTemplate(file_get_contents($fileName),dirname($fileName),$fileName); - $cache->set(self::TEMPLATE_CACHE_PREFIX.$fileName,array($template,time())); - return $template; - } - } - else - return null; - } -} - -/** - * TTemplate implements PRADO template parsing logic. - * A TTemplate object represents a parsed PRADO control template. - * It can instantiate the template as child controls of a specified control. - * The template format is like HTML, with the following special tags introduced, - * - component tags: a component tag represents the configuration of a component. - * The tag name is in the format of com:ComponentType, where ComponentType is the component - * class name. Component tags must be well-formed. Attributes of the component tag - * are treated as either property initial values, event handler attachment, or regular - * tag attributes. - * - property tags: property tags are used to set large block of attribute values. - * The property tag name is in the format of prop:AttributeName, where AttributeName - * can be a property name, an event name or a regular tag attribute name. - * - directive: directive specifies the property values for the template owner. - * It is in the format of <% property name-value pairs %> - * - expressions: expressions are shorthand of {@link TExpression} and {@link TStatements} - * controls. They are in the formate of <= PHP expression > and < PHP statements > - * - comments: There are two kinds of comments, regular HTML comments and special template comments. - * The former is in the format of , which will be treated as text strings. - * The latter is in the format of <%* comments %>, which will be stripped out. - * - * Tags other than the above are not required to be well-formed. - * - * A TTemplate object represents a parsed PRADO template. To instantiate the template - * for a particular control, call {@link instantiateIn($control)}, which - * will create and intialize all components specified in the template and - * set their parent as the control. - * - * @author Qiang Xue - * @version $Revision: $ $Date: $ - * @package System.Web.UI - * @since 3.0 - */ -class TTemplate extends TComponent implements ITemplate -{ - /** - * '' - template comments - * '' - HTML comments - * '<\/?com:([\w\.]+)((?:\s*[\w\.]+=\'.*?\'|\s*[\w\.]+=".*?"|\s*[\w\.]+=<%.*?%>)*)\s*\/?>' - component tags - * '<\/?prop:([\w\.]+)\s*>' - property tags - * '<%@\s*(\w+)((?:\s*[\w\.]+=\'.*?\'|\s*[\w\.]+=".*?")*)\s*%>' - directives - * '<%=?(.*?)%>' - expressions - */ - const REGEX_RULES='/||<\/?com:([\w\.]+)((?:\s*[\w\.]+=\'.*?\'|\s*[\w\.]+=".*?"|\s*[\w\.]+=<%.*?%>)*)\s*\/?>|<\/?prop:([\w\.]+)\s*>|<%@\s*((?:\s*[\w\.]+=\'.*?\'|\s*[\w\.]+=".*?")*)\s*%>|<%=?(.*?)%>/msS'; - - /** - * @var array list of component tags and strings - */ - private $_tpl=array(); - /** - * @var array list of directive settings - */ - private $_directive=array(); - /** - * @var string context path - */ - private $_contextPath; - /** - * @var string template file path (if available) - */ - private $_tplFile=null; - - /** - * Constructor. - * The template will be parsed after construction. - * @param string the template string - * @param string the template context directory - * @param string the template file, null if no file - */ - public function __construct($template,$contextPath,$tplFile=null) - { - $this->_contextPath=$contextPath; - $this->_tplFile=$tplFile; - $this->parse($template); - } - - /** - * @return array name-value pairs declared in the directive - */ - public function getDirective() - { - return $this->_directive; - } - - /** - * @return array the parsed template - */ - public function &getItems() - { - return $this->_tpl; - } - - /** - * Instantiates the template. - * Content in the template will be instantiated as components and text strings - * and passed to the specified parent control. - * @param TControl the parent control - * @throws TTemplateRuntimeException if an error is encountered during the instantiation. - */ - public function instantiateIn($tplControl) - { - $page=$tplControl->getPage(); - $assetManager=$page->getService()->getAssetManager(); - $controls=array(); - foreach($this->_tpl as $key=>$object) - { - if(isset($object[2])) // component - { - if(strpos($object[1],'.')===false) - { - if(class_exists($object[1],false)) - $component=new $object[1]; - else - { - include_once($object[1].Prado::CLASS_FILE_EXT); - if(class_exists($object[1],false)) - $component=new $object[1]; - else - throw new TTemplateRuntimeException('template_component_unknown',$object[1]); - } - } - else - $component=Prado::createComponent($object[1]); - if($component instanceof TControl) - { - $controls[$key]=$component; - $component->setTemplateControl($tplControl); - if(isset($object[2]['id'])) - $tplControl->registerObject($object[2]['id'],$component); - if(isset($object[2]['skinid'])) - { - $component->setSkinID($object[2]['skinid']); - unset($object[2]['skinid']); - } - $component->applyStyleSheetSkin($page); - // apply attributes - foreach($object[2] as $name=>$value) - { - if($component->hasEvent($name)) // is an event - { - if(is_string($value)) - { - if(strpos($value,'.')===false) - $component->attachEventHandler($name,array($component,'TemplateControl.'.$value)); - else - $component->attachEventHandler($name,array($component,$value)); - } - else - throw new TTemplateRuntimeException('template_event_invalid',get_class($component),$name); - } - else if(strpos($name,'.')===false) // is simple property or custom attribute - { - if($component->hasProperty($name)) - { - if($component->canSetProperty($name)) - { - $setter='set'.$name; - if(is_string($value)) - $component->$setter($value); - else if($value[0]===0) - $component->bindProperty($name,$value[1]); - else if($value[0]===1) - $component->$setter($component->evaluateExpression($value[1])); - else // url - { - $url=$assetManager->publishFilePath($this->_contextPath.'/'.$value[1]); - $component->$setter($url); - } - } - else - throw new TTemplateRuntimeException('template_property_readonly',get_class($component),$name); - } - else if($component->getAllowCustomAttributes()) - { - if(is_array($value)) - { - if($value[0]===1) - $value=$component->evaluateExpression($value[1]); - else if($value[0]===2) - $value=$assetManager->publishFilePath($this->_contextPath.'/'.$value[1]); - else - throw new TTemplateRuntimeException('template_attribute_unbindable',get_class($component),$name); - } - $component->getAttributes()->add($name,$value); - } - else - throw new TTemplateRuntimeException('template_property_undefined',get_class($component),$name); - } - else // complex property - { - if(is_string($value)) - $component->setSubProperty($name,$value); - else if($value[0]===0) - $component->bindProperty($name,$value[1]); - else if($value[0]===1) - $component->setSubProperty($component->evaluateExpression($value[1])); - else - { - $url=$assetManager->publishFilePath($this->_contextPath.'/'.$value[1]); - $component->$setter($url); - } - } - } - $parent=isset($controls[$object[0]])?$controls[$object[0]]:$tplControl; - $component->createdOnTemplate($parent); - } - else if($component instanceof TComponent) - { - if(isset($object[2]['id'])) - { - $tplControl->registerObject($object[2]['id'],$component); - if(!$component->hasProperty('id')) - unset($object[2]['id']); - } - foreach($object[2] as $name=>$value) - { - if($component->hasProperty($name)) - { - if($component->canSetProperty($name)) - { - $setter='set'.$name; - if(is_string($value)) - $component->$setter($value); - else if($value[0]===1) - $component->$setter($component->evaluateExpression($value[1])); - else if($value[0]===2) - { - $url=$assetManager->publishFilePath($this->_contextPath.'/'.$value[1]); - $component->$setter($url); - } - else - throw new TTemplateRuntimeException('template_property_unbindable',get_class($component),$name); - } - else - throw new TTemplateRuntimeException('template_property_readonly',get_class($component),$name); - } - else - throw new TTemplateRuntimeException('template_property_undefined',get_class($component),$name); - } - $parent=isset($controls[$object[0]])?$controls[$object[0]]:$tplControl; - $parent->addParsedObject($component); - } - else - throw new TTemplateRuntimeException('template_component_required',$object[1]); - } - else // string - { - if(isset($controls[$object[0]])) - $controls[$object[0]]->addParsedObject($object[1]); - else - $tplControl->addParsedObject($object[1]); - } - } - } - - /** - * Parses a template string. - * - * This template parser recognizes five types of data: - * regular string, well-formed component tags, well-formed property tags, directives, and expressions. - * - * The parsing result is returned as an array. Each array element can be of three types: - * - a string, 0: container index; 1: string content; - * - a component tag, 0: container index; 1: component type; 2: attributes (name=>value pairs) - * If a directive is found in the template, it will be parsed and can be - * retrieved via {@link getDirective}, which returns an array consisting of - * name-value pairs in the directive. - * - * Note, attribute names are treated as case-insensitive and will be turned into lower cases. - * Component and directive types are case-sensitive. - * Container index is the index to the array element that stores the container object. - * If an object has no container, its container index is -1. - * - * @param string the template string - * @throws TTemplateParsingException if a parsing error is encountered - */ - protected function parse($input) - { - $tpl=&$this->_tpl; - $n=preg_match_all(self::REGEX_RULES,$input,$matches,PREG_SET_ORDER|PREG_OFFSET_CAPTURE); - $expectPropEnd=false; - $textStart=0; - $stack=array(); - $container=-1; - $c=0; - for($i=0;$i<$n;++$i) - { - $match=&$matches[$i]; - $str=$match[0][0]; - $matchStart=$match[0][1]; - $matchEnd=$matchStart+strlen($str)-1; - if(strpos($str,'$textStart) - $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); - $textStart=$matchEnd+1; - $type=$match[1][0]; - $attributes=$this->parseAttributes($match[2][0]); - $tpl[$c++]=array($container,$type,$attributes); - if($str[strlen($str)-2]!=='/') // open tag - { - array_push($stack,$type); - $container=$c-1; - } - } - else if(strpos($str,'$textStart) - $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); - $textStart=$matchEnd+1; - $type=$match[1][0]; - - if(empty($stack)) - { - $line=count(explode("\n",substr($input,0,$matchEnd+1))); - if($this->_tplFile===null) - throw new TTemplateParsingException('template_closingtag_unexpected',"Line $line",""); - else - throw new TTemplateParsingException('template_closingtag_unexpected',"{$this->_tplFile} (Line $line)",""); - } - - $name=array_pop($stack); - if($name!==$type) - { - if($name[0]==='@') - $tag=''; - else - $tag=''; - $line=count(explode("\n",substr($input,0,$matchEnd+1))); - if($this->_tplFile===null) - throw new TTemplateParsingException('template_closingtag_expected',"Line $line",$tag); - else - throw new TTemplateParsingException('template_closingtag_expected',"{$this->_tplFile} (Line $line)",$tag); - } - $container=$tpl[$container][0]; - } - else if(strpos($str,'<%@')===0) // directive - { - if($expectPropEnd) - continue; - if($matchStart>$textStart) - $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); - $textStart=$matchEnd+1; - if(isset($tpl[0])) - { - $line=count(explode("\n",substr($input,0,$matchEnd+1))); - if($this->_tplFile===null) - throw new TTemplateParsingException('template_directive_nonunique',"Line $line"); - else - throw new TTemplateParsingException('template_directive_nonunique',"{$this->_tplFile} (Line $line)"); - } - $this->_directive=$this->parseAttributes($match[4][0]); - } - else if(strpos($str,'<%')===0) // expression - { - if($expectPropEnd) - continue; - if($matchStart>$textStart) - $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); - $textStart=$matchEnd+1; - if($str[2]==='=') - $tpl[$c++]=array($container,'TExpression',array('Expression'=>$match[5][0])); - else - $tpl[$c++]=array($container,'TStatements',array('Statements'=>$match[5][0])); - } - else if(strpos($str,'$textStart) - $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); - $textStart=$matchEnd+1; - $expectPropEnd=true; - } - } - else if(strpos($str,'_tplFile===null) - throw new TTemplateParsingException('template_closingtag_unexpected',"Line $line",""); - else - throw new TTemplateParsingException('template_closingtag_unexpected',"{$this->_tplFile} (Line $line)",""); - } - $name=array_pop($stack); - if($name!=='@'.$prop) - { - if($name[0]==='@') - $tag=''; - else - $tag=''; - $line=count(explode("\n",substr($input,0,$matchEnd+1))); - if($this->_tplFile===null) - throw new TTemplateParsingException('template_closingtag_expected',"Line $line",$tag); - else - throw new TTemplateParsingException('template_closingtag_expected',"{$this->_tplFile} (Line $line)",$tag); - } - if(($last=count($stack))<1 || $stack[$last-1][0]!=='@') - { - if($matchStart>$textStart && $container>=0) - { - $value=substr($input,$textStart,$matchStart-$textStart); - if(preg_match('/^<%.*?%>$/msS',$value)) - { - if($value[2]==='#') // databind - $tpl[$container][2][$prop]=array(0,substr($value,3,strlen($value)-5)); - else if($value[2]==='=') // a dynamic initialization - $tpl[$container][2][$prop]=array(1,substr($value,3,strlen($value)-5)); - else - $tpl[$container][2][$prop]=$value; - } - else - $tpl[$container][2][$prop]=$value; - $textStart=$matchEnd+1; - } - $expectPropEnd=false; - } - } - else if(strpos($str,'