/Docs/files/lib/class-dbfactory-php.html
HTML | 50 lines | 22 code | 23 blank | 5 comment | 0 complexity | 597322ef21acf40cfa52aa48f5eb03d7 MD5 | raw file
Possible License(s): GPL-3.0
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
-
- <html><head><title>DbFactory - ezRPG</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
- if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
-
- <!-- Generated by Natural Docs, version 1.4 -->
- <!-- http://www.naturaldocs.org -->
-
- <!-- saved from url=(0026)http://www.naturaldocs.org -->
-
-
-
-
- <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="DbFactory"></a>DbFactory</h1><div class=CBody><p>Factory class for database drivers.</p><h4 class=CHeading>See Also</h4><ul><li><a href="exception-db-php.html#DbException" class=LClass id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">DbException</a></li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#DbFactory" >DbFactory</a></td><td class=SDescription>Factory class for database drivers.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#DbFactory.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#DbFactory.factory" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">factory</a></td><td class=SDescription>A static function to return the correct database object according to the database type.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
-
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="DbFactory.Functions"></a>Functions</h3></div></div>
-
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="DbFactory.factory"></a>factory</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function factory(</td><td class=PParameter nowrap>$type</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'mysql',</td></tr><tr><td></td><td class=PParameter nowrap>$host</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'localhost',</td></tr><tr><td></td><td class=PParameter nowrap>$username</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'root',</td></tr><tr><td></td><td class=PParameter nowrap>$password</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$db</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'ezrpg'</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>A static function to return the correct database object according to the database type.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>$type</td><td class=CDLDescription>The type of database driver to use.</td></tr><tr><td class=CDLEntry>$host</td><td class=CDLDescription>The host of the database server.</td></tr><tr><td class=CDLEntry>$username</td><td class=CDLDescription>Username to login with.</td></tr><tr><td class=CDLEntry>$password</td><td class=CDLDescription>Password to login with.</td></tr><tr><td class=CDLEntry>$db</td><td class=CDLDescription>Name of the database.</td></tr></table><h4 class=CHeading>Returns</h4><p>A new instance of the database driver class.</p><p>Throws a <a href="exception-db-php.html#DbException" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt2', 'link3')" onMouseOut="HideTip('tt2')">DbException</a> on failure.</p><h4 class=CHeading>Example Usage</h4><blockquote><pre>try
- {
- $db = DbFactory::factory('mysql', 'localhost', 'root', 'password', 'ezrpg');
- }
- catch (DbException $e)
- {
- $e->__toString();
- }</pre></blockquote><h4 class=CHeading>See Also</h4><ul><li><a href="exception-db-php.html#DbException" class=LClass id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">DbException</a></li></ul></div></div></div>
-
- </div><!--Content-->
-
-
- <div id=Footer>Copyright © 2009 ezRPG Project · Updated June 26th, 2010 · <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
-
-
- <div id=Menu><div class=MTitle>ezRPG<div class=MSubTitle>Documentation</div></div><div class=MEntry><div class=MFile><a href="../config-php.html">Config</a></div></div><div class=MEntry><div class=MFile><a href="../modules/example-php.html">Module_Example</a></div></div><div class=MEntry><div class=MFile><a href="../modules/skeleton-php.html">Module_Skeleton</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Lib</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="const-errors-php.html">Error Codes</a></div></div><div class=MEntry><div class=MFile><a href="func-log-php.html">Log Functions</a></div></div><div class=MEntry><div class=MFile><a href="func-player-php.html">Player Functions</a></div></div><div class=MEntry><div class=MFile><a href="func-rand-php.html">Random Functions</a></div></div><div class=MEntry><div class=MFile><a href="func-text-php.html">Text Functions</a></div></div><div class=MEntry><div class=MFile><a href="func-validate-php.html">Validation functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Classes</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="class-base_module-php.html">Base_Module</a></div></div><div class=MEntry><div class=MFile id=MSelected>DbFactory</div></div><div class=MEntry><div class=MFile><a href="class-hooks-php.html">Hooks</a></div></div><div class=MEntry><div class=MFile><a href="class-imagebar-php.html">ImageBar</a></div></div><div class=MEntry><div class=MFile><a href="class-modulefactory-php.html">ModuleFactory</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Modules</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../modules/AccountSettings/index-php.html">AccountSettings</a></div></div><div class=MEntry><div class=MFile><a href="../modules/City/index-php.html">City</a></div></div><div class=MEntry><div class=MFile><a href="../modules/EventLog/index-php.html">EventLog</a></div></div><div class=MEntry><div class=MFile><a href="../modules/Index/index-php.html">Index</a></div></div><div class=MEntry><div class=MFile><a href="../modules/Login/index-php.html">Login</a></div></div><div class=MEntry><div class=MFile><a href="../modules/Logout/index-php.html">Logout</a></div></div><div class=MEntry><div class=MFile><a href="../modules/Members/index-php.html">Members</a></div></div><div class=MEntry><div class=MFile><a href="../modules/Register/index-php.html">Register</a></div></div><div class=MEntry><div class=MFile><a href="../modules/StatPoints/index-php.html">StatPoints</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Admin Modules</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../admin/Index/index-php.html">Admin_Index</a></div></div><div class=MEntry><div class=MFile><a href="../admin/Members/index-php.html">Admin_Members</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Database Drivers</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="db-mysql-php.html">Db_mysql</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Exceptions</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="exception-db-php.html">DbException</a></div></div><div class=MEntry><div class=MFile><a href="exception-file-php.html">FileException</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">Index</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Constants.html">Constants</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../install-php.html">Install</a></div></div><div class=MEntry><div class=MLink><a href="http://www.ezrpgproject.com/">ezRPG Project</a></div></div><script type="text/javascript"><!--
- var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
- --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Constants">Constants</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
- HideAllBut([2, 1], 8);// --></script></div><!--Menu-->
-
-
-
- <!--START_ND_TOOLTIPS-->
- <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function factory(</td><td class=PParameter nowrap>$type</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'mysql',</td></tr><tr><td></td><td class=PParameter nowrap>$host</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'localhost',</td></tr><tr><td></td><td class=PParameter nowrap>$username</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'root',</td></tr><tr><td></td><td class=PParameter nowrap>$password</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$db</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%>'ezrpg'</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>A static function to return the correct database object according to the database type.</div></div><div class=CToolTip id="tt2"><div class=CClass>Extends Exception class to specify a database error.</div></div><!--END_ND_TOOLTIPS-->
-
-
-
-
- <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
-
-
- <script language=JavaScript><!--
- if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>