| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 3 | <head> |
| 4 | |
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 6 | <title>URL Helper : CodeIgniter User Guide</title> |
| 7 | |
| 8 | <style type='text/css' media='all'>@import url('../userguide.css');</style> |
| 9 | <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> |
| 10 | |
| 11 | <script type="text/javascript" src="../nav/nav.js"></script> |
| 12 | <script type="text/javascript" src="../nav/prototype.lite.js"></script> |
| 13 | <script type="text/javascript" src="../nav/moo.fx.js"></script> |
| 14 | <script type="text/javascript" src="../nav/user_guide_menu.js"></script> |
| 15 | |
| 16 | <meta http-equiv='expires' content='-1' /> |
| 17 | <meta http-equiv= 'pragma' content='no-cache' /> |
| 18 | <meta name='robots' content='all' /> |
| 19 | <meta name='author' content='ExpressionEngine Dev Team' /> |
| 20 | <meta name='description' content='CodeIgniter User Guide' /> |
| 21 | </head> |
| 22 | <body> |
| 23 | |
| 24 | <!-- START NAVIGATION --> |
| 25 | <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> |
| 26 | <div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div> |
| 27 | <div id="masthead"> |
| 28 | <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> |
| 29 | <tr> |
| 30 | <td><h1>CodeIgniter User Guide Version 1.7</h1></td> |
| 31 | <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> |
| 32 | </tr> |
| 33 | </table> |
| 34 | </div> |
| 35 | <!-- END NAVIGATION --> |
| 36 | |
| 37 | |
| 38 | <!-- START BREADCRUMB --> |
| 39 | <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> |
| 40 | <tr> |
| 41 | <td id="breadcrumb"> |
| 42 | <a href="http://codeigniter.com/">CodeIgniter Home</a> › |
| 43 | <a href="../index.html">User Guide Home</a> › |
| 44 | URL Helper |
| 45 | </td> |
| 46 | <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> |
| 47 | </tr> |
| 48 | </table> |
| 49 | <!-- END BREADCRUMB --> |
| 50 | |
| 51 | <br clear="all" /> |
| 52 | |
| 53 | |
| 54 | <!-- START CONTENT --> |
| 55 | <div id="content"> |
| 56 | |
| 57 | |
| 58 | <h1>URL Helper</h1> |
| 59 | |
| 60 | <p>The URL Helper file contains functions that assist in working with URLs.</p> |
| 61 | |
| 62 | |
| 63 | <h2>Loading this Helper</h2> |
| 64 | |
| 65 | <p>This helper is loaded using the following code:</p> |
| 66 | <code>$this->load->helper('url');</code> |
| 67 | |
| 68 | <p>The following functions are available:</p> |
| 69 | |
| 70 | <h2>site_url()</h2> |
| 71 | |
| 72 | <p>Returns your site URL, as specified in your config file. The index.php file (or whatever you have set as your |
| 73 | site <dfn>index_page</dfn> in your config file) will be added to the URL, as will any URI segments you pass to the function.</p> |
| 74 | |
| 75 | <p>You are encouraged to use this function any time you need to generate a local URL so that your pages become more portable |
| 76 | in the event your URL changes.</p> |
| 77 | |
| 78 | <p>Segments can be optionally passed to the function as a string or an array. Here is a string example:</p> |
| 79 | |
| 80 | <code>echo site_url("news/local/123");</code> |
| 81 | |
| 82 | <p>The above example would return something like: http://example.com/index.php/news/local/123</p> |
| 83 | |
| 84 | <p>Here is an example of segments passed as an array:</p> |
| 85 | |
| 86 | <code> |
| 87 | $segments = array('news', 'local', '123');<br /> |
| 88 | <br /> |
| 89 | echo site_url($segments);</code> |
| 90 | |
| 91 | |
| 92 | <h2>base_url()</h2> |
| 93 | <p>Returns your site base URL, as specified in your config file. Example:</p> |
| 94 | <code>echo base_url();</code> |
| 95 | |
| 96 | |
| 97 | <h2>current_url()</h2> |
| 98 | <p>Returns the full URL (including segments) of the page being currently viewed.</p> |
| 99 | |
| 100 | |
| 101 | <h2>uri_string()</h2> |
| 102 | <p>Returns the URI segments of any page that contains this function. For example, if your URL was this:</p> |
| 103 | <code>http://some-site.com/blog/comments/123</code> |
| 104 | |
| 105 | <p>The function would return:</p> |
| 106 | <code>blog/comments/123</code> |
| 107 | |
| 108 | |
| 109 | <h2>index_page()</h2> |
| 110 | <p>Returns your site "index" page, as specified in your config file. Example:</p> |
| 111 | <code>echo index_page();</code> |
| 112 | |
| 113 | |
| 114 | |
| 115 | <h2>anchor()</h2> |
| 116 | |
| 117 | <p>Creates a standard HTML anchor link based on your local site URL:</p> |
| 118 | |
| 119 | <code><a href="http://example.com">Click Here</a></code> |
| 120 | |
| 121 | <p>The tag has three optional parameters:</p> |
| 122 | |
| 123 | <code>anchor(<var>uri segments</var>, <var>text</var>, <var>attributes</var>)</code> |
| 124 | |
| 125 | <p>The first parameter can contain any segments you wish appended to the URL. As with the <dfn>site_url()</dfn> function above, |
| 126 | segments can be a string or an array.</p> |
| 127 | |
| 128 | <p><strong>Note:</strong> If you are building links that are internal to your application do not include the base URL (http://...). This |
| 129 | will be added automatically from the information specified in your config file. Include only the URI segments you wish appended to the URL.</p> |
| 130 | |
| 131 | <p>The second segment is the text you would like the link to say. If you leave it blank, the URL will be used.</p> |
| 132 | |
| 133 | <p>The third parameter can contain a list of attributes you would like added to the link. The attributes can be a simple string or an associative array.</p> |
| 134 | |
| 135 | <p>Here are some examples:</p> |
| 136 | |
| 137 | <code>echo anchor('news/local/123', 'My News');</code> |
| 138 | |
| 139 | <p>Would produce: <a href="http://example.com/index.php/news/local/123" title="My News">My News</a></p> |
| 140 | |
| 141 | <code>echo anchor('news/local/123', 'My News', array('title' => 'The best news!'));</code> |
| 142 | |
| 143 | <p>Would produce: <a href="http://example.com/index.php/news/local/123" title="The best news!">My News</a></p> |
| 144 | |
| 145 | |
| 146 | <h2>anchor_popup()</h2> |
| 147 | |
| 148 | <p>Nearly identical to the <dfn>anchor()</dfn> function except that it opens the URL in a new window. |
| 149 | |
| 150 | You can specify JavaScript window attributes in the third parameter to control how the window is opened. If |
| 151 | the third parameter is not set it will simply open a new window with your own browser settings. Here is an example |
| 152 | with attributes:</p> |
| 153 | |
| 154 | <code> |
| 155 | |
| 156 | $atts = array(<br /> |
| 157 | 'width' => '800',<br /> |
| 158 | 'height' => '600',<br /> |
| 159 | 'scrollbars' => 'yes',<br /> |
| 160 | 'status' => 'yes',<br /> |
| 161 | 'resizable' => 'yes',<br /> |
| 162 | 'screenx' => '0',<br /> |
| 163 | 'screeny' => '0'<br /> |
| 164 | );<br /> |
| 165 | <br /> |
| 166 | echo anchor_popup('news/local/123', 'Click Me!', $atts);</code> |
| 167 | |
| 168 | <p>Note: The above attributes are the function defaults so you only need to set the ones that are different from what you need. |
| 169 | If you want the function to use all of its defaults simply pass an empty array in the third parameter:</p> |
| 170 | |
| 171 | <code>echo anchor_popup('news/local/123', 'Click Me!', array());</code> |
| 172 | |
| 173 | |
| 174 | <h2>mailto()</h2> |
| 175 | |
| 176 | <p>Creates a standard HTML email link. Usage example:</p> |
| 177 | |
| 178 | <code>echo mailto('me@my-site.com', 'Click Here to Contact Me');</code> |
| 179 | |
| 180 | <p>As with the <dfn>anchor()</dfn> tab above, you can set attributes using the third parameter.</p> |
| 181 | |
| 182 | |
| 183 | <h2>safe_mailto()</h2> |
| 184 | |
| 185 | <p>Identical to the above function except it writes an obfuscated version of the mailto tag using ordinal numbers |
| 186 | written with JavaScript to help prevent the email address from being harvested by spam bots.</p> |
| 187 | |
| 188 | |
| 189 | <h2>auto_link()</h2> |
| 190 | |
| 191 | <p>Automatically turns URLs and email addresses contained in a string into links. Example:</p> |
| 192 | |
| 193 | <code>$string = auto_link($string);</code> |
| 194 | |
| 195 | <p>The second parameter determines whether URLs and emails are converted or just one or the other. Default behavior is both |
| 196 | if the parameter is not specified. Email links are encoded as safe_mailto() as shown above.</p> |
| 197 | |
| 198 | <p>Converts only URLs:</p> |
| 199 | <code>$string = auto_link($string, 'url');</code> |
| 200 | |
| 201 | <p>Converts only Email addresses:</p> |
| 202 | <code>$string = auto_link($string, 'email');</code> |
| 203 | |
| 204 | <p>The third parameter determines whether links are shown in a new window. The value can be TRUE or FALSE (boolean):</p> |
| 205 | <code>$string = auto_link($string, 'both', TRUE);</code> |
| 206 | |
| 207 | |
| 208 | <h2>url_title()</h2> |
| 209 | <p>Takes a string as input and creates a human-friendly URL string. This is useful if, for example, you have a blog |
| 210 | in which you'd like to use the title of your entries in the URL. Example:</p> |
| 211 | |
| 212 | <code>$title = "What's wrong with CSS?";<br /> |
| 213 | <br /> |
| 214 | $url_title = url_title($title);<br /> |
| 215 | <br /> |
| 216 | // Produces: whats-wrong-with-css |
| 217 | </code> |
| 218 | |
| 219 | |
| 220 | <p>The second parameter determines the word delimiter. By default dashes are used. Options are: <dfn>dash</dfn>, or <dfn>underscore</dfn>:</p> |
| 221 | |
| 222 | <code>$title = "What's wrong with CSS?";<br /> |
| 223 | <br /> |
| 224 | $url_title = url_title($title, 'underscore');<br /> |
| 225 | <br /> |
| Derek Jones | 40a2fc8 | 2008-12-09 19:41:25 +0000 | [diff] [blame^] | 226 | // Produces: Whats_wrong_with_CSS |
| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 227 | </code> |
| 228 | |
| Derek Jones | 40a2fc8 | 2008-12-09 19:41:25 +0000 | [diff] [blame^] | 229 | <p>The third parameter determines whether or not lowercase characters are forced. By default they are not. Options are boolean <dfn>TRUE</dfn>/<dfn>FALSE</dfn>:</p> |
| 230 | |
| 231 | <code>$title = "What's wrong with CSS?";<br /> |
| 232 | <br /> |
| 233 | $url_title = url_title($title, 'underscore', TRUE);<br /> |
| 234 | <br /> |
| 235 | // Produces: whats_wrong_with_css |
| 236 | </code> |
| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 237 | |
| 238 | <h3>prep_url()</h3> |
| 239 | <p>This function will add <kbd>http://</kbd> in the event it is missing from a URL. Pass the URL string to the function like this:</p> |
| 240 | <code> |
| 241 | $url = "example.com";<br /><br /> |
| 242 | $url = prep_url($url);</code> |
| 243 | |
| 244 | |
| 245 | |
| 246 | |
| 247 | <h2>redirect()</h2> |
| 248 | |
| 249 | <p>Does a "header redirect" to the local URI specified. Just like other functions in this helper, this one is designed |
| 250 | to redirect to a local URL within your site. You will <strong>not</strong> specify the full site URL, but rather simply the URI segments |
| 251 | to the controller you want to direct to. The function will build the URL based on your config file values.</p> |
| 252 | |
| 253 | <p>The optional second parameter allows you to choose between the "location" |
| 254 | method (default) or the "refresh" method. Location is faster, but on Windows servers it can sometimes be a problem. The optional third parameter allows you to send a specific HTTP Response Code - this could be used for example to create 301 redirects for search engine purposes. The default Response Code is 302. The third parameter is <em>only</em> available with 'location' redirects, and not 'refresh'. Examples:</p> |
| 255 | |
| 256 | <code>if ($logged_in == FALSE)<br /> |
| 257 | {<br /> |
| 258 | redirect('/login/form/', 'refresh');<br /> |
| 259 | }<br /> |
| 260 | <br /> |
| 261 | // with 301 redirect<br /> |
| 262 | redirect('/article/13', 'location', 301);</code> |
| 263 | |
| 264 | <p class="important"><strong>Note:</strong> In order for this function to work it must be used before anything is outputted |
| 265 | to the browser since it utilizes server headers.<br /> |
| 266 | <strong>Note:</strong> For very fine grained control over headers, you should use the <a href="../libraries/output.html">Output Library</a>'s set_header() function.</p> |
| 267 | |
| 268 | |
| 269 | |
| 270 | |
| 271 | |
| 272 | |
| 273 | </div> |
| 274 | <!-- END CONTENT --> |
| 275 | |
| 276 | |
| 277 | <div id="footer"> |
| 278 | <p> |
| 279 | Previous Topic: <a href="typography_helper.html">Typography Helper</a> |
| 280 | · |
| 281 | <a href="#top">Top of Page</a> · |
| 282 | <a href="../index.html">User Guide Home</a> · |
| 283 | Next Topic: <a href="xml_helper.html">XML Helper</a> |
| 284 | </p> |
| 285 | <p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> |
| 286 | </div> |
| 287 | |
| 288 | </body> |
| admin | b0dd10f | 2006-08-25 17:25:49 +0000 | [diff] [blame] | 289 | </html> |