File: Swoole_Http_Response.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (86 lines) | stat: -rw-r--r-- 4,404 bytes parent folder | download | duplicates (2) 
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
 
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Swoole\Http\Response" namespace="Swoole\Http" name="Response">
  <method name="cookie" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the cookies of the HTTP response."/>
      <return type="string"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="true" byreference="false" type="string"/>
    <parameter name="expires" optional="true" byreference="false" type="string"/>
    <parameter name="path" optional="true" byreference="false" type="string"/>
    <parameter name="domain" optional="true" byreference="false" type="string"/>
    <parameter name="secure" optional="true" byreference="false" type="string"/>
    <parameter name="httponly" optional="true" byreference="false" type="string"/>
  </method>
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destruct the HTTP response."/>
      <return type="void"/>
    </docblock>
  </destructor>
  <method name="end" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send data for the HTTP request and finish the response."/>
      <return type="void"/>
    </docblock>
    <parameter name="content" optional="true" byreference="false" type="string"/>
  </method>
  <method name="gzip" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enable the gzip of response content.&#10;"/>
      <return type="ReturnType"/>
    </docblock>
    <parameter name="compress_level" optional="true" byreference="false" type="string"/>
  </method>
  <method name="header" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the HTTP response headers."/>
      <return type="void"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="string"/>
    <parameter name="ucwords" optional="true" byreference="false" type="string"/>
  </method>
  <method name="initHeader" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Init the HTTP response header."/>
      <return type="ReturnType"/>
    </docblock>
  </method>
  <method name="rawcookie" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the raw cookies to the HTTP response."/>
      <return type="ReturnType"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="true" byreference="false" type="string"/>
    <parameter name="expires" optional="true" byreference="false" type="string"/>
    <parameter name="path" optional="true" byreference="false" type="string"/>
    <parameter name="domain" optional="true" byreference="false" type="string"/>
    <parameter name="secure" optional="true" byreference="false" type="string"/>
    <parameter name="httponly" optional="true" byreference="false" type="string"/>
  </method>
  <method name="sendfile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send file through the HTTP response."/>
      <return type="ReturnType"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
    <parameter name="offset" optional="true" byreference="false" type="int"/>
  </method>
  <method name="status" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the status code of the HTTP response."/>
      <return type="ReturnType"/>
    </docblock>
    <parameter name="http_code" optional="false" byreference="false" type="string"/>
  </method>
  <method name="write" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Append HTTP body content to the HTTP response."/>
      <return type="void"/>
    </docblock>
    <parameter name="content" optional="false" byreference="false" type="string"/>
  </method>
</class>