From 112d86bb08a1dd4bde14005f757c95b0fc7a5a21 Mon Sep 17 00:00:00 2001 From: xue <> Date: Sun, 4 Jun 2006 20:51:27 +0000 Subject: Merge from 3.0 branch till 1140. --- framework/Web/UI/TControl.php | 9 ++- framework/Web/UI/TPageStatePersister.php | 2 +- framework/Web/UI/WebControls/TDataBoundControl.php | 8 +- framework/Web/UI/WebControls/TDataGrid.php | 11 +-- framework/Web/UI/WebControls/TDataList.php | 6 +- framework/Web/UI/WebControls/TFileUpload.php | 3 +- framework/Web/UI/WebControls/TListControl.php | 3 +- framework/Web/UI/WebControls/TMarkdown.php | 90 +++++++--------------- framework/Web/UI/WebControls/TMultiView.php | 2 +- framework/Web/UI/WebControls/TRepeater.php | 6 +- framework/Web/UI/WebControls/TTextHighlighter.php | 61 +++++---------- framework/Web/UI/WebControls/TTextProcessor.php | 87 +++++++++++++++++++++ framework/Web/UI/WebControls/TWizard.php | 2 +- 13 files changed, 159 insertions(+), 131 deletions(-) create mode 100644 framework/Web/UI/WebControls/TTextProcessor.php (limited to 'framework/Web/UI') diff --git a/framework/Web/UI/TControl.php b/framework/Web/UI/TControl.php index 10541a37..eced51ea 100644 --- a/framework/Web/UI/TControl.php +++ b/framework/Web/UI/TControl.php @@ -591,6 +591,7 @@ class TControl extends TApplicationComponent implements IRenderable, IBindable } /** + * Sets a custom control attribute. * @param string attribute name * @param string value of the attribute */ @@ -1336,18 +1337,18 @@ class TControl extends TApplicationComponent implements IRenderable, IBindable } /** - * Invokes the parent's onBubbleEvent method. + * Invokes the parent's bubbleEvent method. * A control who wants to bubble an event must call this method in its onEvent method. * @param TControl sender of the event * @param TEventParameter event parameter - * @see onBubbleEvent + * @see bubbleEvent */ protected function raiseBubbleEvent($sender,$param) { $control=$this; while($control=$control->_parent) { - if($control->onBubbleEvent($sender,$param)) + if($control->bubbleEvent($sender,$param)) break; } } @@ -1361,7 +1362,7 @@ class TControl extends TApplicationComponent implements IRenderable, IBindable * @return boolean true if the event bubbling is handled and no more bubbling. * @see raiseBubbleEvent */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { return false; } diff --git a/framework/Web/UI/TPageStatePersister.php b/framework/Web/UI/TPageStatePersister.php index ff5b088b..af470a26 100644 --- a/framework/Web/UI/TPageStatePersister.php +++ b/framework/Web/UI/TPageStatePersister.php @@ -31,7 +31,7 @@ class TPageStatePersister extends TComponent implements IPageStatePersister private $_page; /** - * @param TPage the page that this persister works for + * @return TPage the page that this persister works for */ public function getPage() { diff --git a/framework/Web/UI/WebControls/TDataBoundControl.php b/framework/Web/UI/WebControls/TDataBoundControl.php index 9e6ecbf3..09023b66 100644 --- a/framework/Web/UI/WebControls/TDataBoundControl.php +++ b/framework/Web/UI/WebControls/TDataBoundControl.php @@ -128,7 +128,7 @@ abstract class TDataBoundControl extends TWebControl } /** - * @return boolean if databind has been invoked in the previous page request + * @return boolean whether databind has been invoked in the previous page request */ protected function getIsDataBound() { @@ -272,7 +272,7 @@ abstract class TDataBoundControl extends TWebControl } /** - * Sets page's OnPreLoad event handler as {@link onPagePreLoad}. + * Sets page's OnPreLoad event handler as {@link pagePreLoad}. * If viewstate is disabled and the current request is a postback, * {@link setRequiresDataBinding RequiresDataBinding} will be set true. * This method overrides the parent implementation. @@ -282,7 +282,7 @@ abstract class TDataBoundControl extends TWebControl { parent::onInit($param); $page=$this->getPage(); - $page->attachEventHandler('OnPreLoad',array($this,'onPagePreLoad')); + $page->attachEventHandler('OnPreLoad',array($this,'pagePreLoad')); } /** @@ -291,7 +291,7 @@ abstract class TDataBoundControl extends TWebControl * @param mixed event sender * @param TEventParameter event parameter */ - public function onPagePreLoad($sender,$param) + public function pagePreLoad($sender,$param) { $this->_initialized=true; $isPostBack=$this->getPage()->getIsPostBack(); diff --git a/framework/Web/UI/WebControls/TDataGrid.php b/framework/Web/UI/WebControls/TDataGrid.php index 82c243ca..d2625c0d 100644 --- a/framework/Web/UI/WebControls/TDataGrid.php +++ b/framework/Web/UI/WebControls/TDataGrid.php @@ -217,7 +217,7 @@ class TDataGrid extends TBaseDataList implements INamingContainer } /** - * @return TDataGridColumnCollection automatically specified datagrid columns + * @return TDataGridColumnCollection automatically generated datagrid columns */ public function getAutoColumns() { @@ -683,7 +683,6 @@ class TDataGrid extends TBaseDataList implements INamingContainer } /** - * Handles OnBubbleEvent. * This method overrides parent's implementation to handle * {@link onItemCommand OnItemCommand} event which is bubbled from * {@link TDataGridItem} child controls. @@ -696,7 +695,7 @@ class TDataGrid extends TBaseDataList implements INamingContainer * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TDataGridCommandEventParameter) { @@ -1890,14 +1889,13 @@ class TDataGridItem extends TTableRow implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation by wrapping event parameter * for OnCommand event with item information. * @param TControl the sender of the event * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { @@ -1934,14 +1932,13 @@ class TDataGridPager extends TPanel implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation by wrapping event parameter * for OnCommand event with item information. * @param TControl the sender of the event * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { diff --git a/framework/Web/UI/WebControls/TDataList.php b/framework/Web/UI/WebControls/TDataList.php index 695d072a..0bec8921 100644 --- a/framework/Web/UI/WebControls/TDataList.php +++ b/framework/Web/UI/WebControls/TDataList.php @@ -635,7 +635,6 @@ class TDataList extends TBaseDataList implements INamingContainer, IRepeatInfoUs } /** - * Handles BubbleEvent. * This method overrides parent's implementation to handle * {@link onItemCommand OnItemCommand} event which is bubbled from * {@link TDataListItem} child controls. @@ -648,7 +647,7 @@ class TDataList extends TBaseDataList implements INamingContainer, IRepeatInfoUs * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TDataListCommandEventParameter) { @@ -1356,14 +1355,13 @@ class TDataListItem extends TWebControl implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation by wrapping event parameter * for Command event with item information. * @param TControl the sender of the event * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { diff --git a/framework/Web/UI/WebControls/TFileUpload.php b/framework/Web/UI/WebControls/TFileUpload.php index 41ffaa7f..37689746 100644 --- a/framework/Web/UI/WebControls/TFileUpload.php +++ b/framework/Web/UI/WebControls/TFileUpload.php @@ -152,7 +152,8 @@ class TFileUpload extends TWebControl implements IPostBackDataHandler, IValidata } /** - * @return integer an error code describing the status of this file uploading + * Returns an error code describing the status of this file uploading. + * @return integer the error code * @see http://www.php.net/manual/en/features.file-upload.errors.php */ public function getErrorCode() diff --git a/framework/Web/UI/WebControls/TListControl.php b/framework/Web/UI/WebControls/TListControl.php index 42f09aad..f20ff4cc 100644 --- a/framework/Web/UI/WebControls/TListControl.php +++ b/framework/Web/UI/WebControls/TListControl.php @@ -203,7 +203,7 @@ abstract class TListControl extends TDataBoundControl { $index=$items->findIndexByValue($this->_cachedSelectedValue); if($index===-1 || ($this->_cachedSelectedIndex!==-1 && $this->_cachedSelectedIndex!==$index)) - throw new TInvalidDataValueException('listcontrol_selection_invalid'); + throw new TInvalidDataValueException('listcontrol_selection_invalid',get_class($this)); $this->setSelectedIndex($index); $this->_cachedSelectedValue=null; $this->_cachedSelectedIndex=-1; @@ -594,6 +594,7 @@ abstract class TListControl extends TDataBoundControl public function onSelectedIndexChanged($param) { $this->raiseEvent('OnSelectedIndexChanged',$this,$param); + $this->onTextChanged($param); } /** diff --git a/framework/Web/UI/WebControls/TMarkdown.php b/framework/Web/UI/WebControls/TMarkdown.php index 49660b4e..740653a5 100644 --- a/framework/Web/UI/WebControls/TMarkdown.php +++ b/framework/Web/UI/WebControls/TMarkdown.php @@ -10,13 +10,19 @@ * @package System.Web.UI.WebControls */ +/** + * Using TTextHighlighter and MarkdownParser classes + */ +Prado::using('System.Web.UI.WebControls.TTextHighlighter'); +Prado::using('System.3rdParty.Markdown.MarkdownParser'); + /** * TMarkdown class * * TMarkdown is a control that produces HTML from code with markdown syntax. * - * Markdown is a text-to-HTML conversion tool for web writers. Markdown allows - * you to write using an easy-to-read, easy-to-write plain text format, then + * Markdown is a text-to-HTML conversion tool for web writers. Markdown allows + * you to write using an easy-to-read, easy-to-write plain text format, then * convert it to structurally valid XHTML (or HTML). * Further documentation regarding Markdown can be found at * http://daringfireball.net/projects/markdown/ @@ -27,56 +33,33 @@ * See http://www.pradosoft.com/demos/quickstart/?page=Markdown for * details on the Markdown syntax usage. * + * TMarkdown also performs syntax highlighting for code blocks whose language + * is recognized by {@link TTextHighlighter}. + * The language of a code block must be specified in the first line of the block + * and enclosed within a pair of square brackets (e.g. [php]). + * * @author Wei Zhuo * @version $Revision: $ $Date: $ * @package System.Web.UI.WebControls - * @since 3.0 + * @since 3.0.1 */ -class TMarkdown extends TControl +class TMarkdown extends TTextHighlighter { /** - * @var TTextHighlighter + * Processes a text string. + * This method is required by the parent class. + * @param string text string to be processed + * @return string the processed text result */ - private $_highlighter; - - /** - * Renders body content. - * This method overrides parent implementation by removing - * malicious javascript code from the body content - * @param THtmlWriter writer - */ - public function render($writer) + public function processText($text) { - $textWriter=new TTextWriter; - parent::render(new THtmlWriter($textWriter)); - $writer->write($this->renderMarkdown($textWriter->flush())); - } - - /** - * Use MarkdownParser to render the HTML content. - * @param string markdown content - * @return string HTML content - */ - protected function renderMarkdown($text) - { - $renderer = Prado::createComponent('System.3rdParty.Markdown.MarkdownParser'); + $renderer = new MarkdownParser; $result = $renderer->parse($text); return preg_replace_callback( - '/
\[\s*(\w+)\s*\]\n+((.|\n)*?)\s*<\\/code><\\/pre>/im', 
+				'/
\[\s*(\w+)\s*\]\n+((.|\n)*?)\s*<\\/code><\\/pre>/im',
 				array($this, 'highlightCode'), $result);
 	}
 
-	/**
-	 * @return TTextHighlighter source code highlighter
-	 */
-	public function getTextHighlighter()
-	{
-		if(is_null($this->_highlighter))
-			$this->_highlighter = new TTextHighlighter;
-		return $this->_highlighter;
-	}
-
-	
 	/**
 	 * Highlights source code using TTextHighlighter
 	 * @param array matches of code blocks
@@ -84,29 +67,14 @@ class TMarkdown extends TControl
 	 */
 	protected function highlightCode($matches)
 	{
-		$text = new TTextWriter;
-		$writer = new THtmlWriter($text);
-		$hi = $this->getTextHighlighter();
-		if($hi->getControls()->getCount() > 0)
-			$hi->getControls()->removeAt(0);
-		$hi->addParsedObject(html_entity_decode($matches[2]));
-		$hi->setLanguage($matches[1]);
-		$hi->render($writer);
-		return $text->flush();
-	}
+		$geshi=new GeSHi(html_entity_decode($matches[2],ENT_QUOTES,'UTF-8'), $matches[1]);
+		if($this->getShowLineNumbers())
+			$geshi->enable_line_numbers(GESHI_NORMAL_LINE_NUMBERS);
+		$geshi->enable_classes();
+		if($this->getEnableCopyCode())
+			$geshi->set_header_content($this->getHeaderTemplate());
 
-	/**
-	 * Registers css style for the highlighted result.
-	 * This method overrides parent implementation.
-	 * @param THtmlWriter writer
-	 */
-	public function onPreRender($writer)
-	{
-		parent::onPreRender($writer);
-		$hi = $this->getTextHighlighter();
-		$this->getControls()->insertAt(0,$hi);
-		$hi->onPreRender($writer);
-		$this->getControls()->removeAt(0);
+		return $geshi->parse_code();
 	}
 }
 
diff --git a/framework/Web/UI/WebControls/TMultiView.php b/framework/Web/UI/WebControls/TMultiView.php
index 59b9f53d..b6001f90 100644
--- a/framework/Web/UI/WebControls/TMultiView.php
+++ b/framework/Web/UI/WebControls/TMultiView.php
@@ -213,7 +213,7 @@ class TMultiView extends TControl
 	 * @param mixed event parameter
 	 * @return boolean whether this event is handled
 	 */
-	public function onBubbleEvent($sender,$param)
+	public function bubbleEvent($sender,$param)
 	{
 		if(!$this->_ignoreBubbleEvents && ($param instanceof TCommandEventParameter))
 		{
diff --git a/framework/Web/UI/WebControls/TRepeater.php b/framework/Web/UI/WebControls/TRepeater.php
index 9aa7af8d..2070cb1a 100644
--- a/framework/Web/UI/WebControls/TRepeater.php
+++ b/framework/Web/UI/WebControls/TRepeater.php
@@ -463,7 +463,6 @@ class TRepeater extends TDataBoundControl implements INamingContainer
 	}
 
 	/**
-	 * Handles BubbleEvent.
 	 * This method overrides parent's implementation to handle
 	 * {@link onItemCommand OnItemCommand} event which is bubbled from
 	 * {@link TRepeaterItem} child controls.
@@ -472,7 +471,7 @@ class TRepeater extends TDataBoundControl implements INamingContainer
 	 * @param TEventParameter event parameter
 	 * @return boolean whether the event bubbling should stop here.
 	 */
-	public function onBubbleEvent($sender,$param)
+	public function bubbleEvent($sender,$param)
 	{
 		if($param instanceof TRepeaterCommandEventParameter)
 		{
@@ -717,14 +716,13 @@ class TRepeaterItem extends TControl implements INamingContainer
 	}
 
 	/**
-	 * Handles BubbleEvent.
 	 * This method overrides parent's implementation by wrapping event parameter
 	 * for Command event with item information.
 	 * @param TControl the sender of the event
 	 * @param TEventParameter event parameter
 	 * @return boolean whether the event bubbling should stop here.
 	 */
-	public function onBubbleEvent($sender,$param)
+	public function bubbleEvent($sender,$param)
 	{
 		if($param instanceof TCommandEventParameter)
 		{
diff --git a/framework/Web/UI/WebControls/TTextHighlighter.php b/framework/Web/UI/WebControls/TTextHighlighter.php
index f5c3eca9..a9ccf5bb 100644
--- a/framework/Web/UI/WebControls/TTextHighlighter.php
+++ b/framework/Web/UI/WebControls/TTextHighlighter.php
@@ -11,9 +11,10 @@
  */
 
 /**
- * Using GeSHi and TTextWriter classes
+ * Using GeSHi and TTextProcessor classes
  */
 Prado::using('System.3rdParty.geshi.geshi');
+Prado::using('System.Web.UI.WebControls.TTextProcessor');
 
 /**
  * TTextHighlighter class.
@@ -31,7 +32,7 @@ Prado::using('System.3rdParty.geshi.geshi');
  * @package System.Web.UI.WebControls
  * @since 3.0
  */
-class TTextHighlighter extends TWebControl
+class TTextHighlighter extends TTextProcessor
 {
 	/**
 	 * @return string tag name of the panel
@@ -77,39 +78,30 @@ class TTextHighlighter extends TWebControl
 	}
 
 	/**
-	 * Registers css style for the highlighted result.
-	 * This method overrides parent implementation.
-	 * @param THtmlWriter writer
+	 * @return boolean true will show "Copy Code" link. Defaults to false.
 	 */
-	public function onPreRender($writer)
+	public function getEnableCopyCode()
 	{
-		parent::onPreRender($writer);
-		$this->registerHighlightScripts();
+		return $this->getViewState('CopyCode', false);
 	}
 
 	/**
-	 * HTML-decodes static text.
-	 * This method overrides parent implementation.
-	 * @param mixed object to be added as body content
+	 * @param boolean true to show the "Copy Code" link.
 	 */
-	public function addParsedObject($object)
+	public function setEnableCopyCode($value)
 	{
-		if(is_string($object))
-			$object=html_entity_decode($object);
-		parent::addParsedObject($object);
+		$this->setViewState('CopyCode', TPropertyValue::ensureBoolean($value), false);
 	}
 
 	/**
-	 * Renders body content.
-	 * This method overrides parent implementation by replacing
-	 * the body content with syntax highlighted result.
+	 * Registers css style for the highlighted result.
+	 * This method overrides parent implementation.
 	 * @param THtmlWriter writer
 	 */
-	public function renderContents($writer)
+	public function onPreRender($writer)
 	{
-		$textWriter=new TTextWriter;
-		parent::renderContents(new THtmlWriter($textWriter));
-		$writer->write($this->highlightText($textWriter->flush()));
+		parent::onPreRender($writer);
+		$this->registerHighlightScripts();
 	}
 
 	/**
@@ -131,27 +123,12 @@ class TTextHighlighter extends TWebControl
 	}
 
 	/**
-	 * @return boolean true will show "Copy Code" link. Defaults to false.
-	 */
-	public function getEnableCopyCode()
-	{
-		return $this->getViewState('CopyCode', false);
-	}
-
-	/**
-	 * @param boolean true to show the "Copy Code" link.
-	 */
-	public function setEnableCopyCode($value)
-	{
-		$this->setViewState('CopyCode', TPropertyValue::ensureBoolean($value), false);
-	}
-
-	/**
-	 * Returns the highlighted text.
-	 * @param string text to highlight.
-	 * @return string highlighted text.
+	 * Processes a text string.
+	 * This method is required by the parent class.
+	 * @param string text string to be processed
+	 * @return string the processed text result
 	 */
-	protected function highlightText($text)
+	public function processText($text)
 	{
 		$geshi = new GeSHi(trim($text), $this->getLanguage());
 		if($this->getShowLineNumbers())
diff --git a/framework/Web/UI/WebControls/TTextProcessor.php b/framework/Web/UI/WebControls/TTextProcessor.php
new file mode 100644
index 00000000..4c4c68f2
--- /dev/null
+++ b/framework/Web/UI/WebControls/TTextProcessor.php
@@ -0,0 +1,87 @@
+
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright © 2005 Wei Zhuo
+ * @license http://www.pradosoft.com/license/
+ * @version $Revision: $  $Date: $
+ * @package System.Web.UI.WebControls
+ */
+
+/**
+ * TTextProcessor class.
+ *
+ * TTextProcessor is the base class for classes that process or transform
+ * text content into different forms. The text content to be processed
+ * is specified by {@link setText Text} property. If it is not set, the body
+ * content enclosed within the processor control will be processed and rendered.
+ * The body content includes static text strings and the rendering result
+ * of child controls.
+ *
+ * Note, all child classes must implement {@link processText} method.
+ *
+ * @author Qiang Xue 
+ * @version $Revision: $  $Date: $
+ * @package System.Web.UI
+ * @since 3.0.1
+ */
+abstract class TTextProcessor extends TWebControl
+{
+	/**
+	 * Processes a text string.
+	 * This method must be implemented by child classes.
+	 * @param string text string to be processed
+	 * @return string the processed text result
+	 */
+	abstract public function processText($text);
+
+	/**
+	 * HTML-decodes static text.
+	 * This method overrides parent implementation.
+	 * @param mixed object to be added as body content
+	 */
+	public function addParsedObject($object)
+	{
+		if(is_string($object))
+			$object=html_entity_decode($object,ENT_QUOTES,'UTF-8');
+		parent::addParsedObject($object);
+	}
+
+	/**
+	 * @return string text to be processed
+	 */
+	public function getText()
+	{
+		return $this->getViewState('Text','');
+	}
+
+	/**
+	 * @param string text to be processed
+	 */
+	public function setText($value)
+	{
+		$this->setViewState('Text',$value);
+	}
+
+	/**
+	 * Renders body content.
+	 * This method overrides the parent implementation by replacing
+	 * the body content with the processed text content.
+	 * @param THtmlWriter writer
+	 */
+	public function renderContents($writer)
+	{
+		if(($text=$this->getText())==='' && $this->getHasControls())
+		{
+			$textWriter=new TTextWriter;
+			parent::renderContents(new THtmlWriter($textWriter));
+			$text=$textWriter->flush();
+		}
+		if($text!=='')
+			$writer->write($this->processText($text));
+	}
+
+}
+?>
\ No newline at end of file
diff --git a/framework/Web/UI/WebControls/TWizard.php b/framework/Web/UI/WebControls/TWizard.php
index 811c4e76..fa0fd92a 100644
--- a/framework/Web/UI/WebControls/TWizard.php
+++ b/framework/Web/UI/WebControls/TWizard.php
@@ -1332,7 +1332,7 @@ class TWizard extends TWebControl implements INamingContainer
 	 * @param TEventParameter event parameter
 	 * @throws TInvalidDataValueException if a navigation command is associated with an invalid parameter
 	 */
-	public function onBubbleEvent($sender,$param)
+	public function bubbleEvent($sender,$param)
 	{
 		if($param instanceof TCommandEventParameter)
 		{
-- 
cgit v1.2.3