--- nfo/php/libs/com.newsblob.phphtmllib/ContainerClass.inc 2003/02/22 20:55:22 1.2
+++ nfo/php/libs/com.newsblob.phphtmllib/ContainerClass.inc 2004/05/06 16:23:38 1.4
@@ -3,7 +3,7 @@
/**
* Holds the Container class.
*
- * $Id: ContainerClass.inc,v 1.2 2003/02/22 20:55:22 jonen Exp $
+ * $Id: ContainerClass.inc,v 1.4 2004/05/06 16:23:38 jonen Exp $
*
* @author Walter A. Boring IV
* @package phpHtmlLib
@@ -32,6 +32,7 @@
*
* @author Walter A. Boring IV
* @package phpHtmlLib
+ * @tutorial Container.cls
*
*/
@@ -60,6 +61,7 @@
* The flags that tell us
* how to render the tag
* its contents, and the close
+ * @access private
*/
var $_flags = _NEWLINEAFTERCONTENT;
@@ -72,6 +74,10 @@
* added to the container. This
* works in the same manner as
* the push() method.
+ *
+ * {@source }
+ *
+ * @tutorial Container.cls#constructor
*/
function Container() {
//We do the adding to the content var
@@ -95,6 +101,8 @@
* It just walks through each of the
* class' data and renders it with the
* appropriate indentation.
+ *
+ * {@source }
*
* @param int - the indentation level for
* the container.
@@ -151,6 +159,8 @@
* Same as add().
* NOTE: only exists for 1.1.x compatibility
*
+ * {@source }
+ *
* @deprecated
* @param mixed $content - either string, or tag object.
* @access public
@@ -166,6 +176,11 @@
* adds content to tag as a FIFO.
* You can have n number of parameters.
* each one will get added in succession to the content.
+ *
+ * {@source }
+ *
+ * @tutorial Container.cls#add
+ *
* @param mixed $content - either string, or tag object.
* @access public
*/
@@ -185,6 +200,7 @@
* Same as add_reference
* NOTE : only exists for compatibility with 1.1.x
*
+ * {@source }
* @deprecated
*
* @access public
@@ -219,6 +235,8 @@
/**
* destroy existing content and start with new content.
+ *
+ * {@source }
*
* @access public
* @param mixed $content can be tag object, or raw (string).
@@ -233,6 +251,7 @@
/**
* counts the number of content objects
*
+ * {@source }
* @access public
* @return int
*/
@@ -240,6 +259,19 @@
return $this->_data_count;
}
+
+ /**
+ * get the nth element from content array
+ *
+ * {@source }
+ *
+ * @param int $cell the cell to get
+ * @return mixed
+ */
+ function &get_element( $cell ) {
+ return $this->_content[$cell];
+ }
+
/**
* This method is used to set the bitmask
@@ -248,6 +280,10 @@
*
* NOTE: the child class can override this
* to set the options
+ *
+ * {@source }
+ * @access private
+ *
*/
function _set_flags() {
$this->_flags = _NEWLINEAFTERCONTENT | _INDENT;
@@ -256,6 +292,8 @@
/**
* function to set the indent flag
+ *
+ * {@source }
*
* @access public
* @param boolean $flag TRUE or FALSE
@@ -273,7 +311,7 @@
* This flag gets the current value
* of the indent flag
*
- * @access public
+ * {@source }
*
* @return boolean
*/
@@ -285,7 +323,9 @@
/**
* This function turns on the collapse flag
*
- * @access public
+ * {@source }
+ *
+ * @tutorial Container.cls#collapse
*
* @param boolean - the collapse flag
* @param boolean - the indent flag
@@ -309,6 +349,7 @@
/**
* returns leading indent for tag
*
+ * {@source }
* @access private
*
* @param int the indentation level for this tag.