docs/classes/html.html at develop · royappa/docs

886 lines (842 loc) · 23.4 KB
<!DOCTYPE html>
	<meta charset="utf-8">
	<title>HTML Class - Fuel Documentation</title>
	<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
	<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
	<script type="text/javascript" src="../assets/js/nav.js"></script>
	<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
	<script type="text/javascript">
		$(function() {
			show_nav('classes', '../');
		hljs.tabReplace = '    ';
		hljs.initHighlightingOnLoad();
		<h1>Fuel Documentation</h1>
	<div id="main-nav"></div>
	<section id="content">
		<h2>Html Class</h2>
		<p>The html class is an html wrapper for nearly all html tags.</p>
		<h5>Doctypes</h5>
		<p>We have included a configuration file located at <kbd>fuel/core/config/doctypes.php</kbd> which has all the doctypes.</p>
		<article>
			<h4 id="method_h">h($content = '', $num = 1, $attr = false)</h4>
			<p>The <strong>h</strong> method returns an html heading tag. As you might be aware off the html heading tags come in 6 variations from h1 to h6.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$content</kbd></th>
								<td><i>required</i></td>
								<td>Content to be found between the heading tags.</td>
							</tr>
							<tr>
								<th><kbd>$num</kbd></th>
								<td><strong>1</strong></td>
								<td>Designated number of the heading tag, if no value is supplied, will default to 1.</td>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>false</strong></td>
								<td>Array of attributes to be applied to the heading tag. Content to be found between the heading tags.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated heading tags with its content(and attributes if supplied).</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;h1&gt;Example&lt;/h1&gt;
echo Html::h('Example');
//returns &lt;h2 id="h2" class="sample" style="color:red;"&gt;Some other example&lt;/h2&gt;
echo Html::h('Some other example', '2', array('id' => 'h2', 'class' => 'sample', 'style' => 'color:red'));
//returns &lt;h3 id="sample" class="sample" style="color:blue;"&gt;Variable!&lt;/h3&gt;
$attributes = array('id' => 'sample', 'class' => 'sample', 'style' => 'color:blue');
echo Html::h('Variable!', '3', $attributes);</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_anchor">anchor($href, $text, $attributes = array())</h4>
			<p>The <strong>anchor</strong> method returns an html anchor tag.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$href</kbd></th>
								<td><i>required</i></td>
								<td>Target url</td>
							</tr>
							<tr>
								<th><kbd>$text</kbd></th>
								<td><i>required</i></td>
								<td>Anchor value</td>
							</tr>
							<tr>
								<th><kbd>$attributes</kbd></th>
								<td><strong>false</strong></td>
								<td>Array of attributes to be applied to the anchor tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated anchor tag (and attributes if supplied).</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;a href="http://www.domain.com/example"&gt;Example&lt;/a&gt;
echo Html::anchor('example', 'Example');
//returns &lt;a href="http://www.otherdomain.com/example"&gt;Example&lt;/a&gt;
echo Html::anchor('http://www.otherdomain.com/example', 'Example');
//returns &lt;a href="http://www.domain.com/example" id="a1" class="sample" style="color:red;"&gt;Example&lt;/a&gt;
echo Html::anchor('example', 'Example', array('id' => 'a1', 'class' => 'sample', 'style' => 'color:red'));</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_mail_to">mail_to($email, $text, $subject = null, $attr = array())</h4>
			<p>The <strong>mail_to</strong> method returns an html anchor tag with mailto as target.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$email</kbd></th>
								<td><i>required</i></td>
								<td>Email address</td>
							</tr>
							<tr>
								<th><kbd>$text</kbd></th>
								<td><i>required</i></td>
								<td>Anchor value</td>
							</tr>
							<tr>
								<th><kbd>$subject</kbd></th>
								<td><strong>null</strong></td>
								<td>Anchor value</td>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>empty</strong></td>
								<td>Array of attributes to be applied to the anchor tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated anchor tag (and attributes if supplied).</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;a href="mailto:name@domain.com"&gt;Name&lt;/a&gt;
echo Html::mail_to('name@domain.com', 'Name');
//returns &lt;a href="mailto:name@domain.com?subject=Something"&gt;Name&lt;/a&gt;
echo Html::mail_to('name@domain.com', 'Name', 'Something');
//returns &lt;a href="mailto:name@domain.com" id="a2" class="sample" style="color:red;"&gt;Name&lt;/a&gt;
echo Html:::mail_to('name@domain.com', 'Name', null, array('id' => 'a2', 'class' => 'sample', 'style' => 'color:red'));</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_mail_to_safe">mail_to_safe($email, $text, $subject = null, $attr = array())</h4>
			<p>The <strong>mail_to_safe</strong> method returns javascript code that produces an html anchor tag with mailto as target.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$email</kbd></th>
								<td><i>required</i></td>
								<td>Email address</td>
							</tr>
							<tr>
								<th><kbd>$text</kbd></th>
								<td><i>required</i></td>
								<td>Anchor value</td>
							</tr>
							<tr>
								<th><kbd>$subject</kbd></th>
								<td><strong>null</strong></td>
								<td>Anchor value</td>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>empty</strong></td>
								<td>Array of attributes to be applied to the anchor tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated anchor tag (and attributes if supplied).</td>
					<th>Example</th>
						<pre class="php"><code>//returns
//&lt;script type="text/javascript"&gt
//	var user = "name";
//	var at = "@";
//	var server = "domain.com";
//	document.write('&lt;a href="' + 'mail' + 'to:' + user + at + server + '"&gtName&lt;/a&gt');
//&lt;/script&gt
echo Html::mail_to_safe('name@domain.com', 'Name');</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_br">br($num = 1, $attr = false)</h4>
			<p>The <strong>br</strong> method returns an html break tag.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$num</kbd></th>
								<td><strong>1</strong></td>
								<td>Number of times the break tag should be outputted. If no value is given will default to 1.</td>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>false</strong></td>
								<td>Array of attributes to be applied to the break tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated break tags with its attributes if supplied.</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;br /&gt;
echo Html::br();
//returns &lt;br id="example" class="sample" style="color:red;" /&gt;&lt;br id="h2" class="sample" style="color:red;" /&gt;
echo Html::br('2', array('id' => 'example', 'class' => 'sample', 'style' => 'color:red'));
</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_hr">hr($attr = false)</h4>
			<p>The <strong>hr</strong> method returns an html ruler tag.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>false</strong></td>
								<td>Array of attributes to be applied to the ruler tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated ruler tag with its attributes if supplied.</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;hr /&gt;
echo Html::hr();
//returns &lt;hr id="example" class="sample" style="color:red;" /&gt;
echo Html::hr(array('id' => 'example', 'class' => 'sample', 'style' => 'color:red'));
</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_title">title($content = '')</h4>
			<p>The <strong>title</strong> method returns an html title tag.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$content</kbd></th>
								<td><i>required</i></td>
								<td>Content to be found between the title tags.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated title tag with its content.</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;title&gt;Some Title!&lt;/title&gt;
echo Html::title('Some title!');
//returns &lt;title&gt;&lt;/title&gt;
echo Html::title('');</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_nbs">nbs($num = 1)</h4>
			<p>The <strong>nbs</strong> method returns ascii code for non-breaking whitespaces.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$num</kbd></th>
								<td><strong>1</strong></td>
								<td>Number of non-breaking spaces to be outputted.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated ascii code for non-breaking whitespaces.</td>
					<th>Example</th>
						<pre class="php"><code>//returns &amp;nbsp;
echo Html::nbs();
//returns &amp;nbsp;&amp;nbsp;
echo Html::nbs(2);</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_img">img($src, $attr = array())</h4>
			<p>The <strong>img</strong> method returns an image tag.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$src</kbd></th>
								<td><i>required</i></td>
								<td>Path to image.</td>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>array()</strong></td>
								<td>Attributes array. If no alt attribute is supplied, the alt attribute defaults to the filename.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated image tag.</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;img src="http://example.com/path/to/image.png" alt="image.png" /&gt;
echo Html::img('path/to/image.png');
//returns &lt;img src="http://example.com/path/to/image.png" alt="Alt Message" class="myclass" /&gt;
echo Html::img('path/to/image.png', array("alt" => "Alt Message", class => "myclass"));
</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_meta">meta($name, $content = '', $type = 'name')</h4>
			<p>The <strong>meta</strong> method returns meta tag or tags if multi-level array is supplied.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$name</kbd></th>
								<td><i>required</i></td>
								<td>Can be array containing single or multiple meta parameters or can be name/http-equiv value.</td>
							</tr>
							<tr>
								<th><kbd>$content</kbd></th>
								<td><i>required</i></td>
								<td>If no array is supplied on the $name parameter, $content equals to the meta attribute content's value.</td>
							</tr>
							<tr>
								<th><kbd>$type</kbd></th>
								<td><strong>'name'</strong></td>
								<td>If no value is supplied will default to name. Can be name or http-equiv.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated meta tags.</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;meta name="description" content="Meta Example!" /&gt;
echo Html::meta('description', 'Meta Example!');
//returns &lt;meta name="robots" content="no-cache" /&gt;
echo Html::meta('robots', 'no-cache');
$meta = array(
	array('name' => 'robots', 'content' => 'no-cache'),
	array('name' => 'description', 'content' => 'Meta Example'),
	array('name' => 'keywords', 'content' => 'fuel, rocks'),
//returns &lt;meta name="robots" content="no-cache" /&gt;
//returns &lt;meta name="description" content="Meta Example!" /&gt;
//returns &lt;meta name="keywords" content="fuel, rocks" /&gt;
echo Html::meta($meta);</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_doctype">doctype($type = 'xhtml1-trans')</h4>
			<p>The <strong>doctype</strong> method returns a correctly formated doctype tag.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$type</kbd></th>
								<td>'xhtml1-trans'</td>
								<td>Type of html doctype tag to be outputted.<br />Accepted Values: <kbd>xhtml11</kbd>, <kbd>xhtml1-strict</kbd>, <kbd>xhtml1-trans</kbd>, <kbd>xhtml1-frame</kbd>, <kbd>html5</kbd>, <kbd>html4-strict</kbd>, <kbd>html4-trans</kbd>, <kbd>html4-frame</kbd></td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated doctype tag.</td>
					<th>Example</th>
						<pre class="php"><code>//returns the XHTML1 Transitional doctype tag.
echo Html::doctype();
//returns &lt;!DOCTYPE html&gt;
echo Html::doctype('html5');</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_header">header($content, $attr = false)</h4>
			<p>The <strong>header</strong> method returns a div tag with the id of header. When used along with the Html::doctype('html5') method will default to a header tag.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$content</kbd></th>
								<td><i>required</i></td>
								<td>Content to be found between the tags.</td>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>array()</strong></td>
								<td>Array of attributes to be applied to the tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated header or div tag.</td>
					<th>Example</th>
						<pre class="php"><code>//if html5 is set returns &lt;header&gt;Oh Yeah baby.&lt;/header&gt;
echo Html::header('Oh Yeah baby');
//without html5 returns &lt;div id="header"&gt;Oh Yeah baby.&lt;/div&gt;
echo Html::header('Oh Yeah baby');</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_audio">audio($src, $attr = false)</h4>
			<p>The <strong>audio</strong> method requires you to set html5 as the doctype in order to be used.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$src</kbd></th>
								<td><i>required</i></td>
								<td>Location of the source file or array containing multiple locations.</td>
							</tr>
							<tr>
								<th><kbd>$attr</kbd></th>
								<td><strong>false</strong></td>
								<td>Array of attributes to be applied to the audio tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated audio tag with its sources.</td>
					<th>Example</th>
						<pre class="php"><code>//returns &lt;audio&gt;&lt;source src="../sounds/beep.mp3" /&gt;&lt;/audio&gt;
echo Html::audio('../sounds/beep.mp3');
//returns &lt;audio&gt;&lt;source src="../sounds/beep.mp3" /&gt;&lt;source src="../sounds/frog.mp4" /&gt;&lt;/audio&gt;
echo Html::audio(array('../sounds/beep.mp3','../sounds/frog.mp4'));</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_ul">ul($list, $style = false)</h4>
			<p>The <strong>ul</strong> method returns correctly formated single or multi-level unordered list.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$list</kbd></th>
								<td><i>required</i></td>
								<td>Array containing single or multi-level items to be outputted as list items.</td>
							</tr>
							<tr>
								<th><kbd>$style</kbd></th>
								<td><strong>false</strong></td>
								<td>Array of attributes to be applied to the ul tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated list.</td>
					<th>Example</th>
						<pre class="php"><code>/* returns
&lt;ul id="todo" class="pending"&gt;
	&lt;li&gt;red&lt;/li&gt;
	&lt;li&gt;blue&lt;/li&gt;
	&lt;li&gt;green&lt;/li&gt;
	&lt;li&gt;yellow&lt;/li&gt;
&lt;/ul&gt;
$items = array('red', 'blue', 'green', 'yellow');
$attr = array('id' => 'todo','class' => 'pending');
echo Html::ul($items, $attr);
&lt;ul class="order"&gt;
	&lt;li&gt;colors
		&lt;ul&gt;
			&lt;li&gt;blue&lt;/li&gt;
			&lt;li&gt;red&lt;/li&gt;
			&lt;li&gt;green&lt;/li&gt;
		&lt;/ul&gt;
	&lt;/li&gt;
	&lt;li&gt;sky&lt;/li&gt;
	&lt;li&gt;tools
		&lt;ul&gt;
			&lt;li&gt;screwdriver&lt;/li&gt;
			&lt;li&gt;hammer&lt;/li&gt;
		&lt;/ul&gt;
	&lt;/li&gt;
&lt;/ul&gt;
$items = array(
	'colors' => array('blue', 'red', 'green'),
	'tools' => array('screw driver','hammer')
$attr = array('class' => 'order');
echo Html::ul($items, $attr);</code></pre>
				</tbody>
			</table>
		</article>
		<article>
			<h4 id="method_ol">ol($list, $style = false)</h4>
			<p>The <strong>ol</strong> method returns correctly formated single or multi-level ordered list.</p>
			<table class="method">
				<tbody>
					<th>Static</th>
					<td>Yes</td>
					<th>Parameters</th>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$list</kbd></th>
								<td><i>required</i></td>
								<td>Array containing single or multi-level items to be outputed as list items.</td>
							</tr>
							<tr>
								<th><kbd>$style</kbd></th>
								<td><strong>false</strong></td>
								<td>(Optional) Array of attributes to be applied to the ol tag.</td>
							</tr>
						</table>
					<th>Returns</th>
					<td>String containing the correctly formated list.</td>
					<th>Example</th>
						<pre class="php"><code>/* returns
&lt;ol id="todo" class="pending"&gt;
	&lt;li&gt;red&lt;/li&gt;
	&lt;li&gt;blue&lt;/li&gt;
	&lt;li&gt;green&lt;/li&gt;
	&lt;li&gt;yellow&lt;/li&gt;
&lt;/ol&gt;
$items = array('red', 'blue', 'green', 'yellow');
$attr = array('id' => 'todo','class' => 'pending');
echo Html::ol($items, $attr);
&lt;ol class="order"&gt;
	&lt;li&gt;colors
		&lt;ol&gt;
			&lt;li&gt;blue&lt;/li&gt;
			&lt;li&gt;red&lt;/li&gt;
			&lt;li&gt;green&lt;/li&gt;
		&lt;/ol&gt;
	&lt;/li&gt;
	&lt;li&gt;sky&lt;/li&gt;
	&lt;li&gt;tools
		&lt;ol&gt;
			&lt;li&gt;screwdriver&lt;/li&gt;
			&lt;li&gt;hammer&lt;/li&gt;
		&lt;/ol&gt;
	&lt;/li&gt;
&lt;/ol&gt;
$items = array(
	'colors' => array('blue', 'red', 'green'),
	'tools' => array('screw driver','hammer'));
$attr = array('class' => 'order');
echo Html::ol($items, $attr);</code></pre>
				</tbody>
			</table>
		</article>
	</section>
	<section id="footer">
			<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
			&copy; 2010 - 2011 Fuel Development Team
	</section>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

html.html

Latest commit

History

html.html

File metadata and controls
