Skip to content

Commit

Permalink
I've got to find a good commit message for these docs redesign changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
frankdejonge committed Oct 7, 2011
1 parent ba77149 commit dfb2ef6
Show file tree
Hide file tree
Showing 26 changed files with 11,229 additions and 10,795 deletions.
1,141 changes: 580 additions & 561 deletions classes/html.html

Large diffs are not rendered by default.

1,738 changes: 864 additions & 874 deletions classes/image.html

Large diffs are not rendered by default.

1,325 changes: 672 additions & 653 deletions classes/inflector.html

Large diffs are not rendered by default.

1,046 changes: 532 additions & 514 deletions classes/input.html

Large diffs are not rendered by default.

451 changes: 235 additions & 216 deletions classes/lang.html

Large diffs are not rendered by default.

661 changes: 340 additions & 321 deletions classes/log.html

Large diffs are not rendered by default.

271 changes: 145 additions & 126 deletions classes/migrate.html
Original file line number Diff line number Diff line change
@@ -1,135 +1,154 @@
<!DOCTYPE html>
<html>
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Migrate 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>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
$(function() {
show_nav('classes', '../');
});
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
var path = './../';
var class_prefix = "Migrate::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Migrate - Classes - Fuel Documentation</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<strong>Fuel, a PHP 5.3 Framework</strong>
Documentation
</h1>

<form id="google_search">
<p>
<span id="search_clear">&nbsp;</span>
<input type="submit" name="search_submit" id="search_submit" value="search" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>

<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">table of contents</a>
<div class="clear"></div>
</header>

<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>

<div id="main">

<h2>Migrate Class</h2>

<p>The migrate class allows you to run, walk through and revert <a href="../general/migrations.html">Migrations</a> from your controllers.</p>

<article>
<h4 class="method" id="method_current">current()</h4>
<p>Runs the up and down methods to the migration currently set in the migration config.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code>Migrate::current();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>

<article>
<h4 class="method" id="method_latest">latest()</h4>
<p>Runs up methods for ever migration between the current version and the last in the migrations folder.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>boolean</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code>Migrate::latest();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>

<article>
<h4 class="method" id="method_version">version($version)</h4>
<p>The <strong>version</strong> method will move the migrations up or down to set the schema at a specific migration.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<th><kbd>$version</kbd></th>
<td><i>required</i></td>
<td>The version you are migrating to.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed - Dependent on the <var>$return_type</var>.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Migrate::version($version)</code></pre>
</td>
</tr>
</tbody>
</table>
</article>

<header>
<h1>Fuel Documentation</h1>
</header>

<div id="main-nav"></div>

<section id="content">
<h2>Migrate Class</h2>

<p>The migrate class allows you to run, walk through and revert <a href="../general/migrations.html">Migrations</a> from your controllers.</p>

<article>
<h4 id="method_current">current()</h4>
<p>Runs the up and down methods to the migration currently set in the migration config.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code>Migrate::current();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>

<article>
<h4 id="method_latest">latest()</h4>
<p>Runs up methods for ever migration between the current version and the last in the migrations folder.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>boolean</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code>Migrate::latest();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>

<article>
<h4 id="method_version">version($version)</h4>
<p>The <strong>version</strong> method will move the migrations up or down to set the schema at a specific migration.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<th><kbd>$version</kbd></th>
<td><i>required</i></td>
<td>The version you are migrating to.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed - Dependent on the <var>$return_type</var>.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Migrate::version($version)</code></pre>
</td>
</tr>
</tbody>
</table>
</article>

</section>

<section id="footer">
<p>
<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
&copy; 2010 - 2011 Fuel Development Team
</p>
</section>
</div>

<footer>
<p>
&copy; Fuel Development Team 2010-2011 - <a href="http://fuelphp.com">Fuel</a> is released under the MIT license.
</p>
</footer>
</div>
</body>
</html>
Loading

0 comments on commit dfb2ef6

Please sign in to comment.