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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="streamWrapper" namespace="" name="streamWrapper">
<member name="context" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The current context, or NULL if no context was passed to the caller function.">The current context, or NULL if no context was passed to the caller function.</description>
<var type="resource"/>
</docblock>
</member>
<constructor name="__construct" abstract="false" static="false" final="false">
<docblock>
<description compact="Constructs a new stream wrapper"/>
<return type="void"/>
</docblock>
</constructor>
<destructor name="__destruct" abstract="false" static="false" final="false">
<docblock>
<description compact="Destructs an existing stream wrapper"/>
<return type="void"/>
</docblock>
</destructor>
<method name="dir_closedir" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Close directory handle">This method is called in response to closedir.</description>
<return type="bool"/>
</docblock>
</method>
<method name="dir_opendir" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Open directory handle"/>
<return type="bool"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
<parameter name="options" optional="false" byreference="false" type="int"/>
</method>
<method name="dir_readdir" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Read entry from directory handle"/>
<return type="string"/>
</docblock>
</method>
<method name="dir_rewinddir" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Rewind directory handle">This method is called in response to rewinddir.</description>
<return type="bool"/>
</docblock>
</method>
<method name="mkdir" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a directory">This method is called in response to mkdir.</description>
<return type="bool"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
<parameter name="mode" optional="false" byreference="false" type="int"/>
<parameter name="options" optional="false" byreference="false" type="int"/>
</method>
<method name="rename" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Renames a file or directory">This method is called in response to rename.</description>
<return type="bool"/>
</docblock>
<parameter name="path_from" optional="false" byreference="false" type="string"/>
<parameter name="path_to" optional="false" byreference="false" type="string"/>
</method>
<method name="rmdir" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes a directory">This method is called in response to rmdir.</description>
<return type="bool"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
<parameter name="options" optional="false" byreference="false" type="int"/>
</method>
<method name="stream_cast" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve the underlaying resource"/>
<return type="resource"/>
</docblock>
<parameter name="cast_as" optional="false" byreference="false" type="int"/>
</method>
<method name="stream_close" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Close a resource">This method is called in response to fclose.</description>
<return type="void"/>
</docblock>
</method>
<method name="stream_eof" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Tests for end-of-file on a file pointer"/>
<return type="bool"/>
</docblock>
</method>
<method name="stream_flush" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Flushes the output">This method is called in response to fflush and when the stream is being closed while any unflushed data has been written to it before.</description>
<return type="bool"/>
</docblock>
</method>
<method name="stream_lock" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Advisory file locking"/>
<return type="bool"/>
</docblock>
<parameter name="operation" optional="false" byreference="false" type="int"/>
</method>
<method name="stream_metadata" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Change stream metadata"/>
<return type="bool"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
<parameter name="option" optional="false" byreference="false" type="int"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="stream_open" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Opens file or URL"/>
<return type="bool"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
<parameter name="mode" optional="false" byreference="false" type="string"/>
<parameter name="options" optional="false" byreference="false" type="int"/>
<parameter name="opened_path" optional="false" byreference="false" type="string"/>
</method>
<method name="stream_read" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Read from stream">This method is called in response to fread and fgets.</description>
<return type="string"/>
</docblock>
<parameter name="count" optional="false" byreference="false" type="int"/>
</method>
<method name="stream_seek" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Seeks to specific location in a stream">This method is called in response to fseek.</description>
<return type="bool"/>
</docblock>
<parameter name="offset" optional="false" byreference="false" type="int"/>
<parameter name="whence" optional="false" byreference="false" type="int"/>
</method>
<method name="stream_set_option" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Change stream options"/>
<return type="bool"/>
</docblock>
<parameter name="option" optional="false" byreference="false" type="int"/>
<parameter name="arg1" optional="false" byreference="false" type="int"/>
<parameter name="arg2" optional="false" byreference="false" type="int"/>
</method>
<method name="stream_stat" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve information about a file resource"/>
<return type="array"/>
</docblock>
</method>
<method name="stream_tell" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve the current position of a stream"/>
<return type="int"/>
</docblock>
</method>
<method name="stream_truncate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Truncate stream"/>
<return type="bool"/>
</docblock>
<parameter name="new_size" optional="false" byreference="false" type="int"/>
</method>
<method name="stream_write" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Write to stream">This method is called in response to fwrite.</description>
<return type="int"/>
</docblock>
<parameter name="data" optional="false" byreference="false" type="string"/>
</method>
<method name="unlink" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Delete a file">This method is called in response to unlink.</description>
<return type="bool"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
</method>
<method name="url_stat" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve information about a file"/>
<return type="array"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
<parameter name="flags" optional="false" byreference="false" type="int"/>
</method>
</class>
|