Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / f5a519822db2201b98f822ad4f8659bad2ce9bcd / . / user_guide / database / call_function.html
blob: b439d4460d07d4d47874b54df5858ddc6329486b [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 Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]5<title>CodeIgniter User Guide</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>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]13<script type="text/javascript">
14window.onload = function() {
admine334c472006-10-21 19:44:22 +0000[diff] [blame]15 myHeight = new fx.Height('nav', {duration: 400});
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]25<meta name='description' content='CodeIgniter User Guide' />
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<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>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]36<td><h1>CodeIgniter User Guide Version 1.5.3</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]48<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50<a href="index.html">Database Library</a> &nbsp;&#8250;&nbsp;
51Custom Function Calls
52</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]53<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]54</tr>
55</table>
56<!-- END BREADCRUMB -->
57
58
59<br clear="all" />
60
61
62<!-- START CONTENT -->
63<div id="content">
64
65<h1>Custom Function Calls</h1>
66
67<h2>$this->db->call_function();</h2>
68
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]69<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]70For 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]71by CodeIgniter. You could do so like this:
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]72</p>
73
74<code>$this->db->call_function('<var>get_client_info</var>');</code>
75
76<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]77automatically 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]78Obviously not all function calls are identical between platforms, so there are limits to how useful this function can be in terms of portability.</p>
79
80<p>Any parameters needed by the function you are calling will be added to the second parameter.</p>
81
82<code>$this->db->call_function('<var>some_function</var>', $param1, $param2, etc..);</code>
83
84
85<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>
86
87<code>$this->db->conn_id;</code>
88
89<p>The result ID can be accessed from within your result object, like this:</p>
90
91<code>$query = $this->db->query("SOME QUERY");<br />
92<br />
93<var>$query->result_id;</var></code>
94
95
96
97
98
99
100
101
102
103
104
105
106
107</div>
108<!-- END CONTENT -->
109
110
111<div id="footer">
112<p>
113Previous Topic:&nbsp;&nbsp;<a href="fields.html">Field MetaData</a>
114&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
115<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
116<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
Derek Allard9da4dbc2007-04-03 11:39:35 +0000[diff] [blame]117Next Topic:&nbsp;&nbsp;<a href="caching.html">Query Caching</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]118</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]119<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]120</div>
121
122</body>
123</html>