Skip to content

Commit 888d1ca

Browse files
committed
doc: update README with class API
1 parent 51dcb1d commit 888d1ca

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

README.md

+76
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,82 @@ try {
5454

5555
```
5656

57+
Class
58+
-----
59+
```php
60+
class \QuickBase\QuickBase {
61+
62+
private $defaults;
63+
64+
final public api($action[, $options = array()]);
65+
66+
}
67+
68+
class \QuickBase\QuickBaseError extends \Exception {
69+
70+
protected int $code;
71+
protected string $message;
72+
protected string $details;
73+
74+
protected int $line;
75+
protected string $file;
76+
77+
final public getCode(void);
78+
final public getMessage(void);
79+
final public getDetails(void);
80+
81+
final public getLine(void);
82+
final public getFile(void);
83+
84+
}
85+
86+
class \QuickBase\QuickBaseQuery {
87+
88+
public QuickBase $parent;
89+
public string $action;
90+
public array $settings;
91+
public array $options;
92+
public array $response;
93+
94+
private int $nErrors;
95+
96+
protected string $payload;
97+
98+
final public actionRequest();
99+
final public actionResponse();
100+
final public addFlags();
101+
final public constructPayload();
102+
final public checkForAndHandleError();
103+
final public processOptions();
104+
final public transmit();
105+
106+
final public static arr2Obj(&$arr[, $return = false]);
107+
final public static arr2Xml($arr, &$xml);
108+
final public static cleanXml2Arr(&$arr);
109+
final public static parseCURLHeaders(&$headers);
110+
final public static xml2Arr($xml, &$arr);
111+
112+
}
113+
114+
class \QuickBase\QuickBaseRequest {
115+
116+
final public static API_[Authenticate, DoQuery, etc](&$query);
117+
118+
}
119+
120+
class \QuickBase\QuickBaseResponse {
121+
122+
final public static API_[Authenticate, DoQuery, etc](&$query, &$results);
123+
124+
}
125+
126+
class \QuickBase\QuickBaseOption {
127+
128+
final public static [clist, fields, etc]($val);
129+
130+
}
131+
```
132+
57133
Error Handling
58134
--------------
59135

0 commit comments

Comments
 (0)