summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoranaxamaxan@blackdog.local <anaxamaxan@blackdog.local>2011-02-03 08:09:54 +0100
committeranaxamaxan@blackdog.local <anaxamaxan@blackdog.local>2011-02-03 08:09:54 +0100
commit76696d76e137e98f0597547b71b40a991d8b025b (patch)
treec8ca6b39a62c37d2e542113f4c5124befb0e1a26
parentd09c51afac9df77a52380dc2ac6581a104faa2ff (diff)
Added docs for config->base_url() changes.
-rw-r--r--user_guide/helpers/url_helper.html16
-rw-r--r--user_guide/libraries/config.html5
2 files changed, 20 insertions, 1 deletions
diff --git a/user_guide/helpers/url_helper.html b/user_guide/helpers/url_helper.html
index 6d8bdc240..de28a6f56 100644
--- a/user_guide/helpers/url_helper.html
+++ b/user_guide/helpers/url_helper.html
@@ -70,7 +70,7 @@ URL Helper
<h2>site_url()</h2>
<p>Returns your site URL, as specified in your config file. The index.php file (or whatever you have set as your
-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>
+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, and the <dfn>url_suffix</dfn> as set in your config file.</p>
<p>You are encouraged to use this function any time you need to generate a local URL so that your pages become more portable
in the event your URL changes.</p>
@@ -93,6 +93,20 @@ echo site_url($segments);</code>
<p>Returns your site base URL, as specified in your config file. Example:</p>
<code>echo base_url();</code>
+<p>This function returns the same thing as site_url, without the <dfn>index_page</dfn> or <dfn>url_suffix</dfn> being appended.</p>
+
+<p>Also like site_url, you can supply segments as a string or an array. Here is a string example:</p>
+
+<code>echo base_url("blog/post/123");</code>
+
+<p>The above example would return something like: http://example.com/blog/post/123</p>
+
+<p>This is useful because unlike site_url(), you can supply a string to a file, such as an image or stylesheet. For example:</p>
+
+<code>echo base_url("images/icons/edit.png");</code>
+
+<p>This would give you something like: http://example.com/images/icons/edit.png</p>
+
<h2>current_url()</h2>
<p>Returns the full URL (including segments) of the page being currently viewed.</p>
diff --git a/user_guide/libraries/config.html b/user_guide/libraries/config.html
index 98b6052a9..103161f5d 100644
--- a/user_guide/libraries/config.html
+++ b/user_guide/libraries/config.html
@@ -175,6 +175,11 @@ define('<var>ENVIRONMENT</var>', '<var>development</var>');
<h2>$this->config->site_url();</h2>
<p>This function retrieves the URL to your site, along with the "index" value you've specified in the config file.</p>
+<h2>$this->config->base_url();</h2>
+<p>This function retrieves the URL to your site, plus an optional path such as to a stylesheet or image.</p>
+
+<p>The two functions above are normally accessed via the corresponding functions in the <a href="../helpers/url_helper.html">URL Helper.</a></p>
+
<h2>$this->config->system_url();</h2>
<p>This function retrieves the URL to your <dfn>system folder</dfn>.</p>