Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 9884449add2bf1a52de10b82a366637b595734fd / . / user_guide / database / call_function.html
blob: 6157acfa7313805c96d311da581106e65253a0ad [file] [log] [blame]
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Custom Function Calls</title>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.0</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]43<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45<a href="index.html">Database Library</a> &nbsp;&#8250;&nbsp;
46Custom Function Calls
47</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]48<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]49</tr>
50</table>
51<!-- END BREADCRUMB -->
52
53
54<br clear="all" />
55
56
57<!-- START CONTENT -->
58<div id="content">
59
60<h1>Custom Function Calls</h1>
61
62<h2>$this->db->call_function();</h2>
63
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]64<p>This function enables you to call PHP database functions that are not natively included in CodeIgniter, in a platform independent manner.
admine334c472006-10-21 19:44:22 +0000[diff] [blame]65For example, lets say you want to call the <dfn>mysql_get_client_info()</dfn> function, which is <strong>not</strong> natively supported
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]66by CodeIgniter. You could do so like this:
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]67</p>
68
69<code>$this->db->call_function('<var>get_client_info</var>');</code>
70
71<p>You must supply the name of the function, <strong>without</strong> the <var>mysql_</var> prefix, in the first parameter. The prefix is added
admine334c472006-10-21 19:44:22 +0000[diff] [blame]72automatically based on which database driver is currently being used. This permits you to run the same function on different database platforms.
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]73Obviously not all function calls are identical between platforms, so there are limits to how useful this function can be in terms of portability.</p>
74
75<p>Any parameters needed by the function you are calling will be added to the second parameter.</p>
76
77<code>$this->db->call_function('<var>some_function</var>', $param1, $param2, etc..);</code>
78
79
80<p>Often, you will either need to supply a database connection ID or a database result ID. The connection ID can be accessed using:</p>
81
82<code>$this->db->conn_id;</code>
83
84<p>The result ID can be accessed from within your result object, like this:</p>
85
86<code>$query = $this->db->query("SOME QUERY");<br />
87<br />
88<var>$query->result_id;</var></code>
89
90
91
92
93
94
95
96
97
98
99
100
101
102</div>
103<!-- END CONTENT -->
104
105
106<div id="footer">
107<p>
108Previous Topic:&nbsp;&nbsp;<a href="fields.html">Field MetaData</a>
109&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
110<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
111<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
Derek Allard9da4dbc2007-04-03 11:39:35 +0000[diff] [blame]112Next Topic:&nbsp;&nbsp;<a href="caching.html">Query Caching</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]113</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]114<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]115</div>
116
117</body>
118</html>