| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
| <head> | |
| <title>CodeIgniter User Guide : HTML Helper</title> | |
| <style type='text/css' media='all'>@import url('../userguide.css');</style> | |
| <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> | |
| <script type="text/javascript" src="../nav/nav.js"></script> | |
| <script type="text/javascript" src="../nav/prototype.lite.js"></script> | |
| <script type="text/javascript" src="../nav/moo.fx.js"></script> | |
| <script type="text/javascript" src="../nav/user_guide_menu.js"></script> | |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| <meta http-equiv='expires' content='-1' /> | |
| <meta http-equiv= 'pragma' content='no-cache' /> | |
| <meta name='robots' content='all' /> | |
| <meta name='author' content='ExpressionEngine Dev Team' /> | |
| <meta name='description' content='CodeIgniter User Guide' /> | |
| </head> | |
| <body> | |
| <!-- START NAVIGATION --> | |
| <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> | |
| <div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div> | |
| <div id="masthead"> | |
| <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> | |
| <tr> | |
| <td><h1>CodeIgniter User Guide Version 1.6.1</h1></td> | |
| <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> | |
| </tr> | |
| </table> | |
| </div> | |
| <!-- END NAVIGATION --> | |
| <!-- START BREADCRUMB --> | |
| <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> | |
| <tr> | |
| <td id="breadcrumb"> | |
| <a href="http://codeigniter.com/">CodeIgniter Home</a> › | |
| <a href="../index.html">User Guide Home</a> › | |
| Directory Helper | |
| </td> | |
| <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> | |
| </tr> | |
| </table> | |
| <!-- END BREADCRUMB --> | |
| <br clear="all" /> | |
| <!-- START CONTENT --> | |
| <div id="content"> | |
| <h1>HTML Helper</h1> | |
| <p>The HTML Helper file contains functions that assist in working with HTML.</p> | |
| <h2>Loading this Helper</h2> | |
| <p>This helper is loaded using the following code:</p> | |
| <code>$this->load->helper('html');</code> | |
| <p>The following functions are available:</p> | |
| <h2>br()</h2> | |
| <p>Generates line break tags (<br />) based on the number you submit. Example:</p> | |
| <code>echo br(3);</code> | |
| <p>The above would produce: <br /><br /><br /></p> | |
| <h2>heading()</h2> | |
| <p>Lets you create HTML <h1> tags. The first parameter will contain the data, the | |
| second the size of the heading. Example:</p> | |
| <code>echo heading('Welcome!', 3);</code> | |
| <p>The above would produce: <h3>Welcome!</h3></p> | |
| <h2>img()</h2> | |
| <p>Lets you create HTML <img /> tags. The first parameter contains the image source. There is data, the | |
| second the size of the heading. Example:</p> | |
| <code>echo img('images/picture.jpg');<br /> | |
| // gives <img src="http://site.com/images/picture.jpg" /></code> | |
| <p>There is an optional second parameter that is a TRUE/FALSE value that specifics if the src should have the page specified by $config['index_page'] added to the address it creates. Presumably, this would be if you were using a media controller.</p> | |
| <p><code>echo img('images/picture.jpg', TRUE);<br /> | |
| // gives <img src="http://site.com/index.php/images/picture.jpg" /></code></p> | |
| <p>Additionally, an associative array can be passed to the img() function for complete control over all attributes and values.</p> | |
| <p><code> $image_properties = array(<br /> | |
| 'src' => 'images/picture.jpg',<br /> | |
| 'alt' => 'Me, demonstrating how to eat 4 slices of pizza at one time',<br /> | |
| 'class' => 'post_images',<br /> | |
| 'width' => '200',<br /> | |
| 'height' => '200',<br /> | |
| 'title' => 'That was quite a night',<br /> | |
| 'rel' => 'lightbox',<br /> | |
| );<br /> | |
| <br /> | |
| img($image_properties);<br /> | |
| // <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" /></code></p> | |
| <h2>link_tag()</h2> | |
| <p>Lets you create HTML <link /> tags. This is useful for stylesheet links, as well as other links. The parameters are href, with optional rel, type, title, media and index_page. index_page is a TRUE/FALSE value that specifics if the href should have the page specified by $config['index_page'] added to the address it creates.<code> | |
| echo link_tag('css/mystyles.css');<br /> | |
| // gives <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css" /></code></p> | |
| <p>Further examples:</p> | |
| <code> | |
| echo link_tag('favicon.ico', 'shortcut icon', 'image/ico');<br /> | |
| // <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico" /> | |
| <br /> | |
| <br /> | |
| echo link('feed', 'alternate', 'application/rss+xml', 'My RSS Feed');<br /> | |
| // <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed" /> </code> | |
| <p>Additionally, an associative array can be passed to the link() function for complete control over all attributes and values.</p> | |
| <p><code> | |
| $link = array(<br /> | |
| 'href' => 'css/printer.css',<br /> | |
| 'rel' => 'stylesheet',<br /> | |
| 'type' => 'text/css',<br /> | |
| 'media' => 'print'<br /> | |
| );<br /> | |
| <br /> | |
| echo link_tag($link);<br /> | |
| // <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" /></code></p> | |
| <h2>nbs()</h2> | |
| <p>Generates non-breaking spaces (&nbsp;) based on the number you submit. Example:</p> | |
| <code>echo nbs(3);</code> | |
| <p>The above would produce: &nbsp;&nbsp;&nbsp;</p> | |
| <h2>ol() and ul()</h2> | |
| <p>Permits you to generate ordered or unordered HTML lists from simple or multi-dimensional arrays. Example:</p> | |
| <code> | |
| $this->load->helper('html');<br /> | |
| <br /> | |
| $list = array(<br /> | |
| 'red', <br /> | |
| 'blue', <br /> | |
| 'green',<br /> | |
| 'yellow'<br /> | |
| );<br /> | |
| <br /> | |
| $attributes = array(<br /> | |
| 'class' => 'boldlist',<br /> | |
| 'id' => 'mylist'<br /> | |
| );<br /> | |
| <br /> | |
| echo ul($list, $attributes);<br /> | |
| </code> | |
| <p>The above code will produce this:</p> | |
| <code> | |
| <ul class="boldlist" id="mylist"><br /> | |
| <li>red</li><br /> | |
| <li>blue</li><br /> | |
| <li>green</li><br /> | |
| <li>yellow</li><br /> | |
| </ul> | |
| </code> | |
| <p>Here is a more complex example, using a multi-dimensional array:</p> | |
| <code> | |
| $this->load->helper('html');<br /> | |
| <br /> | |
| $list = array(<br /> | |
| 'colors' => array(<br /> | |
| 'red',<br /> | |
| 'blue',<br /> | |
| 'green'<br /> | |
| ),<br /> | |
| 'shapes' => array(<br /> | |
| 'round', <br /> | |
| 'square',<br /> | |
| 'circles' => array(<br /> | |
| 'ellipse', <br /> | |
| 'oval', <br /> | |
| 'sphere'<br /> | |
| )<br /> | |
| ),<br /> | |
| 'moods' => array(<br /> | |
| 'happy', <br /> | |
| 'upset' => array(<br /> | |
| 'defeated' => array(<br /> | |
| 'dejected',<br /> | |
| 'disheartened',<br /> | |
| 'depressed'<br /> | |
| ),<br /> | |
| 'annoyed',<br /> | |
| 'cross',<br /> | |
| 'angry'<br /> | |
| )<br /> | |
| )<br /> | |
| );<br /> | |
| <br /> | |
| <br /> | |
| echo ul($list);</code> | |
| <p>The above code will produce this:</p> | |
| <code> | |
| <ul class="boldlist" id="mylist"><br /> | |
| <li>colors<br /> | |
| <ul><br /> | |
| <li>red</li><br /> | |
| <li>blue</li><br /> | |
| <li>green</li><br /> | |
| </ul><br /> | |
| </li><br /> | |
| <li>shapes<br /> | |
| <ul><br /> | |
| <li>round</li><br /> | |
| <li>suare</li><br /> | |
| <li>circles<br /> | |
| <ul><br /> | |
| <li>elipse</li><br /> | |
| <li>oval</li><br /> | |
| <li>sphere</li><br /> | |
| </ul><br /> | |
| </li><br /> | |
| </ul><br /> | |
| </li><br /> | |
| <li>moods<br /> | |
| <ul><br /> | |
| <li>happy</li><br /> | |
| <li>upset<br /> | |
| <ul><br /> | |
| <li>defeated<br /> | |
| <ul><br /> | |
| <li>dejected</li><br /> | |
| <li>disheartened</li><br /> | |
| <li>depressed</li><br /> | |
| </ul><br /> | |
| </li><br /> | |
| <li>annoyed</li><br /> | |
| <li>cross</li><br /> | |
| <li>angry</li><br /> | |
| </ul><br /> | |
| </li><br /> | |
| </ul><br /> | |
| </li><br /> | |
| </ul> | |
| </code> | |
| </div> | |
| <!-- END CONTENT --> | |
| <div id="footer"> | |
| <p> | |
| Previous Topic: <a href="form_helper.html">Form Helper</a> | |
| · | |
| <a href="#top">Top of Page</a> · | |
| <a href="../index.html">User Guide Home</a> · | |
| Next Topic: <a href="inflector_helper.html"> Inflector Helper</a> | |
| </p> | |
| <p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2007 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> | |
| </div> | |
| </body> | |
| </html> |