Skip to content

D
doctrine-dbal
Switch branch/tag
Find file
Normal viewHistoryPermalink
inflector.html 5.32 KB
Newer Older
Roman S. Borschel's avatar
Adding new API docs.
10acab65
 
Roman S. Borschel committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">

<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">

<title>Inflector (Doctrine)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/inflector.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">Doctrine\Common\Util\Inflector</div>
<div class="location">/Doctrine/Common/Util/Inflector.php at line 38</div>

<h1>Class Inflector</h1>

<pre class="tree"><strong>Inflector</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>Inflector</strong></p>

<div class="comment" id="overview_description"><p>Doctrine inflector has static methods for inflecting text</p><p>The methods in these classes are from several different sources collected
across several different php projects and several different authors. The 
original author names and emails are not known</p></div>

<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>1.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3189 $</dd>
<dt>Author:</dt>
<dd>Konsta Vesterinen <kvesteri@cc.hut.fi></dd>
<dd>Jonathan H. Wage <jonwage@gmail.com></dd>
</dl>
<hr>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static  string</td>
<td class="description"><p class="name"><a href="#camelize()">camelize</a>(string word)</p><p class="description">Camelize a word. </p></td>
</tr>
<tr>
<td class="type">static  string</td>
<td class="description"><p class="name"><a href="#classify()">classify</a>(string word)</p><p class="description">Convert a word in to the format for a Doctrine class name. </p></td>
</tr>
<tr>
<td class="type">static  string</td>
<td class="description"><p class="name"><a href="#tableize()">tableize</a>(string word)</p><p class="description">Convert word in to the format for a Doctrine table name. </p></td>
</tr>
</table>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Util/Inflector.php at line 68</div>
<h3 id="camelize()">camelize</h3>
<code class="signature">public static  string <strong>camelize</strong>(string word)</code>
<div class="details">
<p>Camelize a word. This uses the classify() method and turns the first character to lowercase</p><dl>
<dt>Returns:</dt>
<dd>$word</dd>
</dl>
</div>

<hr>

<div class="location">/Doctrine/Common/Util/Inflector.php at line 57</div>
<h3 id="classify()">classify</h3>
<code class="signature">public static  string <strong>classify</strong>(string word)</code>
<div class="details">
<p>Convert a word in to the format for a Doctrine class name. Converts 'table_name' to 'TableName'</p><dl>
<dt>Parameters:</dt>
<dd>word - Word to classify</dd>
<dt>Returns:</dt>
<dd>$word Classified word</dd>
</dl>
</div>

<hr>

<div class="location">/Doctrine/Common/Util/Inflector.php at line 46</div>
<h3 id="tableize()">tableize</h3>
<code class="signature">public static  string <strong>tableize</strong>(string word)</code>
<div class="details">
<p>Convert word in to the format for a Doctrine table name. Converts 'ModelName' to 'model_name'</p><dl>
<dt>Parameters:</dt>
<dd>word - Word to tableize</dd>
<dt>Returns:</dt>
<dd>$word Tableized word</dd>
</dl>
</div>

<hr>

<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/inflector.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>