Skip to content

Commit

Permalink
Fixed a bunch of typos
Browse files Browse the repository at this point in the history 
Mainly unencoded ampersands, "it's" -> "its", other typos
  • Loading branch information
Alex Russell committed Feb 24, 2012
1 parent 7a82075 commit 37f4ac0
Show file tree
Hide file tree
Showing 28 changed files with 55 additions and 55 deletions.
4 changes: 2 additions & 2 deletions classes/asset/advanced.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ <h3>Advanced usage</h3>

<p>
The Asset class supports the use of multiple instances. This might prove useful if you are using themes, where
every theme has it's own set of assets, or you are developing a modular application where each module provides
it's own set of assets.
every theme has its own set of assets, or you are developing a modular application where each module provides
its own set of assets.
</p>
<p>
In these cases, it would not be handy to have only a single instance and use search paths, since the chances of
Expand Down
2 changes: 1 addition & 1 deletion classes/autoloader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ <h4 class="method" id="method_add_core_namespace">add_core_namespace($namespace,

<article>
<h4 class="method" id="method_load">load($class)</h4>
<p>The <strong>load</strong> method tries to find the class, load it, and fire it's _init function if exists.</p>
<p>The <strong>load</strong> method tries to find the class, load it, and fire its _init function if exists.</p>
<table class="method">
<tbody>
<tr>
Expand Down
16 changes: 8 additions & 8 deletions classes/database/usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ <h2>Database Usage</h2>
Normal database interactions are to go through the <a href="./db.html">DB class</a>.
The following examples will give you a feel for how to go about using databases in Fuel.
</p>
<p>Database usage is devided into a couple of segments:</p>
<p>Database usage is divided into a couple of segments:</p>

<ul>
<li><a href="#running-queries">Running queries</a></li>
Expand Down Expand Up @@ -144,7 +144,7 @@ <h3 id="selecting">Selection data</h3>
<h3 id="results">Results</h3>
<p>
Executing a select query will generate a result object containing the requested database records.
By default the result is fetched as associative arrays. Here is an exaple how to influence this
By default the result is fetched as associative arrays. Here is an example how to influence this
behaviour.
</p>
<pre class="php"><code>// Will fetch the result as an associative array.
Expand All @@ -162,7 +162,7 @@ <h3 id="results">Results</h3>
// Just count the results, it returns an int.
$num_rows = count($result);
</code></pre>
<p>To access these results you eighter loop through the result object directly, or get the result array.</p>
<p>To access these results you either loop through the result object directly, or get the result array.</p>
<pre class="php"><code>$result = DB::select()->from('users')->execute();
foreach($result as $item)
{
Expand All @@ -182,7 +182,7 @@ <h3 id="results">Results</h3>
foreach($on_key as $id => $item)
{
// $id will contain the records id
// do something with $item or it's $id
// do something with $item or its $id
}

$key_value = $result->as_array('id', 'email');
Expand Down Expand Up @@ -313,7 +313,7 @@ <h3 id="updating">Updating</h3>
<h3 id="inserting">Inserting</h3>
<p>
For inserting data we use <a href="./db.html#method_insert">DB::insert</a>.
If succesfully executed an insert query will return an array containing a
If successfully executed an insert query will return an array containing a
list of insert id and rows created.
</p>
<pre class="php"><code>// Will execute INSERT INTO `users`(`name`,`email`,`password`)
Expand All @@ -324,7 +324,7 @@ <h3 id="inserting">Inserting</h3>
'password' => 's0_s3cr3t',
))->execute();
</code></pre>
<p>You can also set the columns and values seperatly</p>
<p>You can also set the columns and values separately</p>

<pre class="php"><code>// Will execute INSERT INTO `users`(`name`,`email`,`password`)
// VALUES ("John Random", "[email protected]", "s0_s3cr3t")
Expand Down Expand Up @@ -373,9 +373,9 @@ <h3 id="joins">Joins</h3>
<h3 id="escaping">Escaping</h3>

<p>Fields and values in database calls are escaped by default. In some cases you'll want to not escape data. The DB class provides a method to create <em>database expressions</em>, <a href="./db.html#method_expr">DB::expr</a>. If you don't want a value to get escaped, just wrap it in a database expression.</p>
<p>Database expressions are especially helpful when dealing with thing like MySQL's native function (like <em>COUNT</em>) and predefined constands (like <em>DEFAULT</em>).</p>
<p>Database expressions are especially helpful when dealing with thing like MySQL's native function (like <em>COUNT</em>) and predefined constants (like <em>DEFAULT</em>).</p>

<pre class="php"><code>// Set a field to it's default
<pre class="php"><code>// Set a field to its default
DB::update('users')->where('id', '=', 1)->set(array(
'some_column' => DB::expr('DEFAULT'),
))->execute();
Expand Down
4 changes: 2 additions & 2 deletions classes/fieldset.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h1>
<h2>Fieldset Class</h2>

<p>
The Fieldset class is used to create a form and handle its' validation in an object oriented way. It uses the Form
The Fieldset class is used to create a form and handle its validation in an object oriented way. It uses the Form
and Validation classes. This class itself is only meant to model the fieldset and its fields while the other
two classes do the real work.
</p>
Expand Down Expand Up @@ -609,7 +609,7 @@ <h4 class="method" id="method_populate">populate($input, $repopulate = false)</h
<tr>
<th><kbd>$repopulate</kbd></th>
<td><code>false</code></td>
<td>Use the repopulate() method after inital populating</td>
<td>Use the repopulate() method after initial populating</td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion classes/file/handlers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h3 id="usage">Usage</h3>
$file = \File::get(DOCROOT.'/here_is_my/textfile.txt');
</code></pre>

<p>Now we've got the file handler, we can use it's methods to get something done.</p>
<p>Now we've got the file handler, we can use its methods to get something done.</p>

<pre class="code"><code>// Let's rename rename it.
$file->rename('new_name');
Expand Down
10 changes: 5 additions & 5 deletions classes/form.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h4 class="method" id="method_close">close()</h4>
<article>
<h4 class="method" id="method_input">input($field, $value = null, $attributes = array())</h4>
<p>
Creates an html input element. It can be set using the fieldname, it's value and tag attributes or all
Creates an html input element. It can be set using the fieldname, its value and tag attributes or all
in one array as the first argument.
</p>
<table class="method">
Expand Down Expand Up @@ -191,7 +191,7 @@ <h4 class="method" id="method_input">input($field, $value = null, $attributes =
<article>
<h4 class="method" id="method_button">button($field, $value = null, $attributes = array())</h4>
<p>
Creates an html button element. It can be set using the fieldname, it's value and tag attributes or all
Creates an html button element. It can be set using the fieldname, its value and tag attributes or all
in one array as the first argument.
</p>
<table class="method">
Expand Down Expand Up @@ -391,7 +391,7 @@ <h4 class="method" id="method_submit">submit($field, $value = null, $attributes

<article>
<h4 class="method" id="method_textarea">textarea($field, $value = null, $attributes = array())</h4>
<p>Creates an html textarea element. It can be set using the fieldname, it's value and tag attributes or all
<p>Creates an html textarea element. It can be set using the fieldname, its value and tag attributes or all
in one attribute for the first argument.</p>
<table class="method">
<tbody>
Expand Down Expand Up @@ -443,7 +443,7 @@ <h4 class="method" id="method_textarea">textarea($field, $value = null, $attribu

<article>
<h4 class="method" id="method_select">select($field, $values = null, $options = array(), $attributes = array())</h4>
<p>Creates an html select element. It can be set using the fieldname, it's selected value(s), it's options
<p>Creates an html select element. It can be set using the fieldname, its selected value(s), its options
and tag attributes or all in one attribute for the first argument.</p>
<table class="method">
<tbody>
Expand Down Expand Up @@ -475,7 +475,7 @@ <h4 class="method" id="method_select">select($field, $values = null, $options =
<th><kbd>$options</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>Associative array of value=>label pairs, may also contain option groups as
opt_name=>array() where the array contains it's set of value=>label pairs.</td>
opt_name=>array() where the array contains its set of value=>label pairs.</td>
</tr>
<tr>
<th><kbd>$attributes</kbd></th>
Expand Down
6 changes: 3 additions & 3 deletions classes/html.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,12 @@ <h4 class="method" id="method_mail_to_safe">mail_to_safe($email, $text, $subject
<th>Example</th>
<td>
<pre class="php"><code>//returns
//&lt;script type="text/javascript"&gt
//&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
// document.write('&lt;a href="' + 'mail' + 'to:' + user + at + server + '"&gt;Name&lt;/a&gt;');
//&lt;/script&gt;
echo Html::mail_to_safe('[email protected]', 'Name');</code></pre>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion classes/mongo/methods.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h2>Mongo_Db Class Methods</h2>

<p>
The Mongo_Db class allows you to interact with MongoDB databases. While in some cases it's
simular to interacting with databases like MySQL there are some distinct differences.
similar to interacting with databases like MySQL there are some distinct differences.
</p>

<p class="note">
Expand Down
2 changes: 1 addition & 1 deletion classes/theme/introduction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h3 id="intro">Introduction</h3>
</p>
<p>
Like modules and packages, themes can be stored in multiple locations. You can define the paths to these locations in the
configuration file, or add them to the theme instance at runtime. A theme is identified by it's name, which must be equal
configuration file, or add them to the theme instance at runtime. A theme is identified by its name, which must be equal
to the name of the theme folder used in one of the theme locations. If the theme is defined in multiple locations,
the first one found will be used.
</p>
Expand Down
4 changes: 2 additions & 2 deletions classes/theme/methods.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ <h4 class="method" id="method_active">active($theme = null)</h4>
<pre class="php"><code>// Get the default instance
$theme = \Theme::instance();

// set the active theme to 'darkglow', and return it's definition
// set the active theme to 'darkglow', and return its definition
$active = $theme->active('darkglow');
</code></pre>
</td>
Expand Down Expand Up @@ -607,7 +607,7 @@ <h4 class="method" id="method_fallback">fallback($theme = null)</h4>
<pre class="php"><code>// Get the default instance
$theme = \Theme::instance();

// set the fallback theme to 'basic', and return it's definition
// set the fallback theme to 'basic', and return its definition
$fallback = $theme->fallback('basic');
</code></pre>
</td>
Expand Down
4 changes: 2 additions & 2 deletions classes/upload/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h3 id="configuration">Configuration</h3>
<td><pre class="php"><code>array()</code></pre></td>
<td>
Array of allowed file extensions. If empty or not defined, all file extensions are allowed.
Extensions need to be defined in lower case only. If a file is uploaded in upper case, it's extension
Extensions need to be defined in lower case only. If a file is uploaded in upper case, its extension
will be matched against the whitelist in lower case.
</td>
</tr>
Expand All @@ -95,7 +95,7 @@ <h3 id="configuration">Configuration</h3>
<td><pre class="php"><code>array()</code></pre></td>
<td>
Array of disallowed file extensions. If empty or not defined, all file extensions are allowed.
Extensions need to be defined in lower case only. If a file is uploaded in upper case, it's extension
Extensions need to be defined in lower case only. If a file is uploaded in upper case, its extension
will be matched against the blacklist in lower case.
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion classes/upload/usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ <h4 class="method" id="method_register">register($event, $callback)</h4>

<p class="note">
<strong>Note:</strong> if you alter the contents of the <strong>$file</strong> array in your callback, you have to make sure that the
information is still valid, as the Upload class won't perform it's checks again. The only exception to this rule is the '<strong>saved_to</strong>' path,
information is still valid, as the Upload class won't perform its checks again. The only exception to this rule is the '<strong>saved_to</strong>' path,
which will be checked and created if required after the callback has been executed.
</p>
</article>
Expand Down
4 changes: 2 additions & 2 deletions general/coding_standards.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,8 @@ <h3 id="comparison_logical">Comparisons, Logical operators</h3>

<p>Comparing function/method returns and variables should be type aware, for example some functions may return
<kbd>false</kbd>, and when comparing this return the type sensitive operators such as <kbd>===</kbd> or <kbd>!==</kbd>. Additionally, use of
<kbd>and</kbd> or <kbd>or</kbd> is preferred over <kbd>&&</kbd> or <kbd>||</kbd> for readability. In some cases, this cannot be avoided and the use of
<kbd>&&</kbd> or <kbd>||</kbd> as its required may be used. The <kbd>!</kbd> should have spaces on both sides when used.</p>
<kbd>and</kbd> or <kbd>or</kbd> is preferred over <kbd>&amp;&amp;</kbd> or <kbd>||</kbd> for readability. In some cases, this cannot be avoided and the use of
<kbd>&amp;&amp;</kbd> or <kbd>||</kbd> as its required may be used. The <kbd>!</kbd> should have spaces on both sides when used.</p>

<pre class="php"><code>if ($var == false and $other_var != 'some_value')
if ($var === false or my_function() !== false)
Expand Down
2 changes: 1 addition & 1 deletion general/controllers/base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h4 id="more_parameters">Using more parameters from the URL</h4>
<h4 id="returning_results">Returning the result</h4>

<p>
A controller action should return it's result. The result can be anything that can be a string, or
A controller action should return its result. The result can be anything that can be a string, or
anything that can be cast to string, like for example a View object.
</p>

Expand Down
2 changes: 1 addition & 1 deletion general/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ <h3>What is a module?</h3>
A module is a group of independent MVC elements. The use of modules allows for re-usability and encapsulation of your code.
A module typically resides within an application sub-directory named <strong>modules</strong>.
It is suggested to take advantage of modules whenever you're working on a large project,
of which you believe it's code-base will be more than just a few lines of code.
of which you believe the code-base will be more than just a few lines of code.
It will help you to keep things neatly in order.
</p>

Expand Down
4 changes: 2 additions & 2 deletions general/packages.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ <h3 id="installing">Installing packages</h3>
<code>app/config/config.php</code> or use <a href="../classes/package.html#method_load">Package::load()</a>.</p>

<h3 id="creation">Creating packages</h3>
<p>To help people understand what you are doing it's best to stucture your package like so:</p>
<p>To help people understand what you are doing it's best to structure your package like so:</p>

<pre><code>/packages
/package
Expand Down Expand Up @@ -102,7 +102,7 @@ <h3 id="creation">Creating packages</h3>
// Set the second argument to <kbd>true</kbd> to prefix and be able to overwrite core classes
Autoloader::add_core_namespace('Mypackage', true);

// And add the classes, this is usefull for:
// And add the classes, this is useful for:
// - optimization: no path searching is necessary
// - it's required to be able to use as a core namespace
// - if you want to break the autoloader's path search rules
Expand Down
8 changes: 4 additions & 4 deletions general/security.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h3>Output encoding</h3>
what happens, you will always have access to the original data.
</p>
<p>
It also means you don't run into trouble when you need data in it's unaltered form. One common example is the
It also means you don't run into trouble when you need data in its unaltered form. One common example is the
data produced by html editors like TinyMCE or ckeditor, used in lots of application for enduser content editing.
In such cases you might want to run <a href="#xss">XSS Filtering</a> on these input variables to filter out
any nasty surprises that might have crept in, since this is a typical example of data you don't want
Expand Down Expand Up @@ -166,15 +166,15 @@ <h3>XSS filtering</h3>
</p>
<p class="note">
For performance reasons, it is recommended that you use the <a href="../classes/security.html#method_xss_clean">xss_clean</a> method
on individual input values, rather then as a generic input filter.
on individual input values, rather than as a generic input filter.
</p>
</article>

<article id="input">
<h3>Input filtering</h3>
<p>
Although not enabled by default, you can configure Fuel to filter all input ($_GET, $_POST and $_COOKIE) on every page request.
To do so, configure the functions or methods to be used to filter them in the applications config/config.php file.
To do so, configure the functions or methods to be used to filter them in the application's config/config.php file.
</p>
<pre class="php"><code>/**
* Security settings
Expand Down Expand Up @@ -205,7 +205,7 @@ <h3>SQL injection</h3>
</p>
<p>
Fuel protects against SQL injection by escaping all values passed to one of the Database class methods. Since this happens at the level
of Fuel's central Query Builder, all code that uses the Query Builder, including Fuels ORM package, will automatically use escaping.
of Fuel's central Query Builder, all code that uses the Query Builder, including Fuel's ORM package, will automatically use escaping.
</p>

</article>
Expand Down
2 changes: 1 addition & 1 deletion installation/download.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ <h3 id="contribute">Contribute to the core</h3>
<p>Fuel is developed using a community approach and we encourage participation. If you are interested in
contributing, please take a second to read our <a href="../general/coding_standards.html">Coding
Standards</a>. Any contributions that do not meet these guidelines will not be accepted. Otherwise:
fork, commit & make pull-request. If you don't know how: <a href="http://help.github.com/forking/">
fork, commit &amp; make pull-request. If you don't know how: <a href="http://help.github.com/forking/">
http://help.github.com/forking/</a>
</p>

Expand Down
2 changes: 1 addition & 1 deletion installation/instructions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ <h3 id="manual">Manual Installation Instructions</h3>
where you want to use Fuel.</li>
<li>Placing the fuel directory outside of the public document directory is encouraged for security
reasons.</li>
<li>Edit the paths in index.php to point to your app, core & packages directories.</li>
<li>Edit the paths in index.php to point to your app, core &amp; packages directories.</li>
</ul>
<pre class="plain"><code>/
fuel/
Expand Down
2 changes: 1 addition & 1 deletion packages/auth/drivers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3 id="implementing_function">Implementing functions.</h3>
<pre class="php"><code>/**
* Get the user's ID
*
* @return Array containing this driver's ID & the user's ID
* @return Array containing this driver's ID &amp; the user's ID
*/
public function get_user_id()
{
Expand Down
2 changes: 1 addition & 1 deletion packages/auth/usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ <h4 id="method_has_access" class="method">has_access($condition, $specific = nul
Response::redirect('no_admin');
}

// check if user can also update & delete comments
// check if user can also update &amp; delete comments
Auth::has_access('comments.[update,delete]');

// The same with an array instead of a string
Expand Down
6 changes: 3 additions & 3 deletions packages/oil/generate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,19 +82,19 @@ <h3 id="controllers">Controllers</h3>

public function action_action1()
{
$this->template->title = 'Posts &raquo Action1';
$this->template->title = 'Posts &raquo; Action1';
$this->template->content = View::forge('posts/action1');
}

public function action_action2()
{
$this->template->title = 'Posts &raquo Action2';
$this->template->title = 'Posts &raquo; Action2';
$this->template->content = View::forge('posts/action2');
}

public function action_action3()
{
$this->template->title = 'Posts &raquo Action3';
$this->template->title = 'Posts &raquo; Action3';
$this->template->content = View::forge('posts/action3');
}

Expand Down
Loading

0 comments on commit 37f4ac0

Please sign in to comment.