File: oci-statement-type.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (166 lines) | stat: -rw-r--r-- 3,930 bytes parent folder | download
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.oci-statement-type" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>oci_statement_type</refname>
  <refpurpose>Returns the type of a statement</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>oci_statement_type</methodname>
   <methodparam><type>resource</type><parameter>statement</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns a keyword identifying the type of the
   OCI8 <parameter>statement</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>statement</parameter></term>
     <listitem>
      <para>
       A valid OCI8 statement identifier from <function>oci_parse</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the type of <parameter>statement</parameter> as one of the
   following strings.
   <table>
    <title>Statement type</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Return String</entry>
       <entry>Notes</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>ALTER</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>BEGIN</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>CALL</literal></entry>
       <entry>Introduced in PHP 5.2.1 (PECL OCI8 1.2.3)</entry>
      </row>
      <row>
       <entry><literal>CREATE</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>DECLARE</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>DELETE</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>DROP</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>INSERT</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>SELECT</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>UPDATE</literal></entry>
       <entry>&nbsp;</entry>
      </row>
      <row>
       <entry><literal>UNKNOWN</literal></entry>
       <entry>&nbsp;</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <para>
   Returns &false; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>oci_statement_type</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$conn = oci_connect('hr', 'welcome', 'localhost/XE');

$stid = oci_parse($conn, 'DELETE FROM departments WHERE department_id = 130;');
if (oci_statement_type($stid) == "DELETE") {
    trigger_error('You are not allowed to delete from this table', E_USER_ERROR);
}
else {
    oci_execute($stid);  // delete the row
}

oci_free_statement($stid);
oci_close($conn);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    In PHP versions before 5.0.0 you must
    use <function>ocistatementtype</function> instead.
    &oci.name.compat.note;
   </para>
  </note>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->