tutorials/phpHtmlLib/Container.cls

<refentry id="{@id}">
 <refnamediv>
  <refname>Container</refname>
  <refpurpose>This is the base class for all of phpHtmlLib</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <author>
    by Walter A. Boring IV
     <authorblurb>{@link mailto:waboring@3gstech.com}</authorblurb>
    </author>
   <copyright>March 2004, Walter A. Boring IV</copyright>
   <releaseinfo>phpHtmlLib 2.4.x</releaseinfo>
  </refsynopsisdivinfo>  
 </refsynopsisdiv>
 <refsect1 id="{@id description}">
  <title>Description</title>
  <para>This class is nothing more then a container widget.  It lets you
   push data into it, and it will render each item indented properly so it works with the rest of the libs.</para>
  <para>This is helpfull when you have a function that wants to return multiple Tag Objects
   or widgets.  Just wrap them in this container
   and they will all get rendered with the current indentation level.</para>
 </refsect1>
 <refsect1 id="{@id example}">
  <title>Example</title>
  <para>
   <example>
   <![CDATA[
  $c = container('this is a', html_b('test') );
  $c->add( html_br() );
  print $c->render();]]>
   </example>
  </para>
 </refsect1>

 <refsect1 id="{@id constructor}">
  <title>Constructor call</title>
  <para>
      <para>This lets you pass in data that you want automatically
       added to the container.  You can add as man items in the 
       call the constructor.  Then you can use the add() method
       to add more items later.</para>
   <example>
   <![CDATA[$c = container('this is a', html_b('test'));]]>
   </example>
  </para>
 </refsect1>
 <refsect1 id="{@id add}">
  <title>add Method</title>
  <para>
      <para>This lets you add new data to the container. You can pass in
      strings, integers and other Container child objects that implement the
      render() method.</para>
   <example>
   <![CDATA[$c = container();
$c->add('testing', 1, 2, 3);]]>
   </example>
   <para>The output:
   <example><![CDATA[testing
1
2
3]]>
   </example>
   </para>
  </para>
 </refsect1>

 <refsect1 id="{@id collapse}">
  <title>Collapse</title>
  <para>
      <para>This method is used to force the output to exist on 1 line, instead
      of a newline for every element added.  </para>
   <example>
   <![CDATA[$c = container();
$c->set_collapse();   
$c->add('testing', 1, 2, 3);]]>
   </example>
   <para>The output:
   <example><![CDATA[testing123]]></example>
   </para>
  </para>
 </refsect1>
</refentry>
1	jonen	1.1	<refentry id="{@id}">
2			<refnamediv>
3			<refname>Container</refname>
4			<refpurpose>This is the base class for all of phpHtmlLib</refpurpose>
5			</refnamediv>
6			<refsynopsisdiv>
7			<refsynopsisdivinfo>
8			<author>
9			by Walter A. Boring IV
10			<authorblurb>{@link mailto:waboring@3gstech.com}</authorblurb>
11			</author>
12			<copyright>March 2004, Walter A. Boring IV</copyright>
13			<releaseinfo>phpHtmlLib 2.4.x</releaseinfo>
14			</refsynopsisdivinfo>
15			</refsynopsisdiv>
16			<refsect1 id="{@id description}">
17			<title>Description</title>
18			<para>This class is nothing more then a container widget. It lets you
19			push data into it, and it will render each item indented properly so it works with the rest of the libs.</para>
20			<para>This is helpfull when you have a function that wants to return multiple Tag Objects
21			or widgets. Just wrap them in this container
22			and they will all get rendered with the current indentation level.</para>
23			</refsect1>
24			<refsect1 id="{@id example}">
25			<title>Example</title>
26			<para>
27			<example>
28			<![CDATA[
29			$c = container('this is a', html_b('test') );
30			$c->add( html_br() );
31			print $c->render();]]>
32			</example>
33			</para>
34			</refsect1>
35
36			<refsect1 id="{@id constructor}">
37			<title>Constructor call</title>
38			<para>
39			<para>This lets you pass in data that you want automatically
40			added to the container. You can add as man items in the
41			call the constructor. Then you can use the add() method
42			to add more items later.</para>
43			<example>
44			<![CDATA[$c = container('this is a', html_b('test'));]]>
45			</example>
46			</para>
47			</refsect1>
48			<refsect1 id="{@id add}">
49			<title>add Method</title>
50			<para>
51			<para>This lets you add new data to the container. You can pass in
52			strings, integers and other Container child objects that implement the
53			render() method.</para>
54			<example>
55			<![CDATA[$c = container();
56			$c->add('testing', 1, 2, 3);]]>
57			</example>
58			<para>The output:
59			<example><![CDATA[testing
60			1
61			2
62			3]]>
63			</example>
64			</para>
65			</para>
66			</refsect1>
67
68			<refsect1 id="{@id collapse}">
69			<title>Collapse</title>
70			<para>
71			<para>This method is used to force the output to exist on 1 line, instead
72			of a newline for every element added. </para>
73			<example>
74			<![CDATA[$c = container();
75			$c->set_collapse();
76			$c->add('testing', 1, 2, 3);]]>
77			</example>
78			<para>The output:
79			<example><![CDATA[testing123]]></example>
80			</para>
81			</para>
82			</refsect1>
83			</refentry>
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26